Updated ast_engine README.md#124
Conversation
MoezLabiadh
left a comment
MoezLabiadh
left a comment
There was a problem hiding this comment.
Looks good to me! The README is really useful. I just added a couple of comments on the File adapter (kml adapter no longer exists) and running tests (markers...)
|
|
||
| This package uses `pytest`. | ||
|
|
||
| Run all tests: |
There was a problem hiding this comment.
I think it is worth mentioning that tests carries the "unit" marker and convention is "uv run pytest -m unit" to run all "unit" tests. In the future Integration tests can carry a different marker and stay out of the default "unit" fast test runs.
| ```text | ||
| ast_engine/tests/ | ||
| ├── unit/ | ||
| ├── integration/ |
There was a problem hiding this comment.
Also worth mentioning that integration tests are live-database checks and will need their own marker to seperate from unit tests. Today these are done with the smoke scripts under "scripts/" (currently only scripts/oracle_smoke.py, which runs the real Oracle adapter against BCGW) - credentials come from the BCGW_USER / BCGW_PASSWORD / BCGW_HOST environment variables, or a prompt, never hardcoded.
There was a problem hiding this comment.
Added some additional notes about additional markers as dev progresses. Please have a look and adjust as needed once merged.
|
Awesome Job Steve, this looks really good and is really useful! Thanks! |
|
Looks great. This triggers some changes to how we do things. Also... is |
| ```text | ||
| .venv/ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
is uv pip install -e required for local dev use or do our tests etc work without that?
There was a problem hiding this comment.
Not needed as uv sync projects are installed as editable packages, so changes to the project are available immediately when ran locally.
| Open a pull request into `main`. | ||
|
|
||
| ### Pull Request Checklist | ||
|
|
There was a problem hiding this comment.
This is good. Creating a ticket to include this in a pull request form.
4 participants
The README includes supporting guidance for configuration, developer setup, logging, error handling, test execution, Git branch workflow, and general development standards for the AST Engine package. Please add your documentation to the relevant section as development continues.