Harmonize readme and dev guide (fixes https://github.com/stacklok/codegate/issues/700) #701
Conversation
docs/development.md
Outdated
| 3. Set up virtual environment | ||
|
|
||
| ```bash | ||
| python -m venv venv | ||
| source venv/bin/activate # On Windows: venv\Scripts\activate | ||
| ``` | ||
|
|
||
| 4. Install project dependencies: |
There was a problem hiding this comment.
Thanks for the PR Doug, looks good. FYI.. don't need to create a venv with poetry, it creates its own when you run poetry install.
You can then do:
poetry run pytest tests/integration/integration_tests.py or poetry run codegate serve --log-level DEBUG --log-format TEXT etc.
There is also a plugin poetry self add poetry-plugin-shell, with this you can run codegate direct
There was a problem hiding this comment.
@lukehinds Makes sense! Would you prefer we advise just using poetry run in the docs for simplicity (as opposed to bringing in the shell plugin option to those docs)? For example:
Then run import_packages to ensure integration test data is created:
poetry run python scripts/import_packages.pyThen the integration tests can be executed by running:
poetry run python tests/integration/integration_tests.py
- Removed information from README that repeated or conflicted with the Development Guide (docs/development.md). - Moved development guidance that was only in the README into the Development Guide - Added a note to clarify context needed for running integration tests.
wright-io
force-pushed
the
harmonize-readme-and-dev-guide-700
branch
from
1f5a8d3 to
9ea6f2f
Compare
|
@lukehinds Would appreciate another review on this, if you don't mind. |
|
Yeah, don't worry about mentioning the shell plugin. |
No description provided.