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

Make into a proper python package w/ standalone protocol definitions #8

Merged
merged 14 commits into from
Jun 13, 2024

Conversation

ajfabbri
Copy link
Collaborator

@ajfabbri ajfabbri commented Jun 13, 2024

Continue the work from #6, making this a python package that is ready to publish, and improving support for separate protocol definitions and generated assets:

  • Eliminate separate toolchain install script, and do it automatically from python tool, i.e. generate.py --install-toolchain
  • generate.py replace --docs-dir with --output-dir. Now we have:
    • Your inputs: --protocol-dir <Path with your version subdirs with Avro IDL files>
    • Your output: --output-dir <Path to output generate schemas / code / docs to>
  • Tweaks for. publishing this as a python package so users can just python -m pip install interface_gen
    • Tested with test.pypi.org here.
    • Added publish.md doc on how to publish.

Note: command for running generate.py has changed: you need to run it as a module as shown in the updated instructions at interface_gen/README.md. This allows the import paths to work correctly both when running from pip install and from the source tree.

- Fix requirements.txt hook into hatch build backend.
- Move requirements.txt to top-level dir.
- Adjust paths to reflect new python project layout.
- Add documentation on how to publish the package.
@ajfabbri ajfabbri force-pushed the af/package2 branch 4 times, most recently from c0336b9 to 1be9ece Compare June 13, 2024 17:09
@ajfabbri ajfabbri merged commit e955017 into main Jun 13, 2024
3 checks passed
@ajfabbri ajfabbri deleted the af/package2 branch June 13, 2024 17:34
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.

1 participant