Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add details about developing python #127

Merged
merged 1 commit into from
Nov 25, 2024
Merged

docs: Add details about developing python #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,38 @@ Bus 003 Device 078: ID 32ac:0020 Framework Computer Inc LED Matrix Input Module
bcdDevice 0.17
```

## Developing

One time setup

```
# Install dependencies on Ubuntu
sudo apt install python3 python3-tk

# Install dependencies on Fedora
sudo dnf install python3 python3-tkinter

# Create local venv and enter it
python3 -m venv venv
source venv/bin/activate

# Install package into local env
python3 -m pip install -e .
```

Developing

```
# In every new shell, source the virtual environment
source venv/bin/activate

# Launch GUI or commandline
ledmatrixgui
ledmatrixctl

# Launch Python REPL and import the library
# As example, launch the GUI
> python3
>>> from inputmodule import cli
>>> cli.main_gui()
```
Loading