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

Python: Improve project setup and test runner conveniences after unboxing. Add CI configuration. Prepare packaging. #10

Merged
merged 6 commits into from
May 20, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented May 17, 2024

About

  • Use vanilla setuptools-based pyproject.toml instead of Poetry
  • Improve setup_grammar.py grammar compiler/generator
  • Make project setup and running software tests self-contained
  • Improve documentation
  • Add CI configuration for software tests and Dependabot

Details

I think Poetry will only be needed for larger or more complex projects. For a project like this, I think a vanilla setuptools-based pyproject.toml will be enough.

amotl added 4 commits May 17, 2024 18:22
- Add logging, to inform the user about different steps and input/output
  files when invoking the compilation/generation process.

- Optimize file reading and writing using `pathlib`.

- Add a few TODO/FIXME inline comments.
- A pytest `conftest.py` file will invoke the runtime grammar generator
  when the generated grammar module files do not exist.

- By defining top-level Python package dependencies within a
  `requirements.txt` file, we can use Dependabot to drive dependency
  package upgrades.
@amotl amotl force-pushed the amo/tests-python branch 3 times, most recently from 6b25d94 to 35c10f8 Compare May 17, 2024 16:51
@amotl amotl requested review from seut and surister May 17, 2024 16:51
@amotl amotl force-pushed the amo/tests-python branch from 35c10f8 to 1be2a9e Compare May 17, 2024 16:54
@amotl amotl marked this pull request as ready for review May 17, 2024 16:55
@amotl amotl merged commit 4115508 into master May 20, 2024
5 checks passed
@amotl amotl deleted the amo/tests-python branch May 20, 2024 21:42
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