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.

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

Bookworm/Pi5 Compatibility: Upgrade to latest boilerplate #26

Merged
merged 8 commits into from
May 23, 2024

Conversation

Gadgetoid
Copy link
Member

@Gadgetoid Gadgetoid commented Nov 24, 2023

This should fix the issue with ruff reporting:

qa: commands[4]> ruff --format=github .
error: unexpected argument '--format' found

And bring a few other things - including the virtual environment helpers - up to date.

⚠️ Note: the master branch will need renaming to main for badges and actions to function correctly.

The changes to io_regs.py look scary, but I used black to reformat the file and avoid any mistakes, then lined up all the comments again because I will die on that hill.

Testing

If you're a Bookworm / Pi 5 user running into virtual environment issues, you can try this library like so:

git clone https://github.com/pimoroni/ioe-python -b boilerplate-update
cd ioe-python
./install.sh --unstable

The ./install.sh script will create a pimoroni virtual environment that's shared between our products. (or use your existing venv if you've already activated one.)

For the reasons behind these changes and other information, see:

* CI: Update GitHub Actions versions.
* QA: Add shellcheck and fix/ignore all issues.
* install.sh: slightly better feedback for setup commands.
* install.sh: fix quoting bug in do_config_backup.
* install.sh: don't output printf commands.
@Gadgetoid Gadgetoid changed the title CI & QA: Update packaging from latest boilerplate. Bookworm/Pi5 Compatibility: Upgrade to latest boilerplate Feb 13, 2024
@thirdr
Copy link

thirdr commented Mar 18, 2024

⚠ WARNING: Error: Failed to generate documentation.

Warn: Cannot find spec for pimoroni-ioexpander (from pimoroni-ioexpander):
Traceback (most recent call last):
  File "/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/extract.py", line 62, in walk_specs
    raise ModuleNotFoundError(modname)
ModuleNotFoundError: pimoroni-ioexpander
 (/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/__init__.py:509)
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/__main__.py", line 286, in <module>
    cli()
  File "/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/__main__.py", line 199, in cli
    pdoc.pdoc(
  File "/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/__init__.py", line 509, in pdoc
    for module_name in extract.walk_specs(modules):
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ryan/.virtualenvs/pimoroni/lib/python3.11/site-packages/pdoc/extract.py", line 85, in walk_specs
    raise ValueError(
ValueError: No modules found matching spec: pimoroni-ioexpander

* install.sh: drop quotes around apt packages.
* Makefile: fail make tag if dev tools not installed.
* tox.ini: update ruff invocation to avoid deprecation warning.
* install.sh: drop symlink warning for /boot/config.txt.
@Gadgetoid Gadgetoid merged commit 7450859 into master May 23, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants