Learn how you can become a contributor to the Airbyte Python CDK.
- Make sure Poetry is installed.
- Run
poetry install - For examples, check out the
examplesfolder. They can be run viapoetry run python examples/<example file> - Unit tests and type checks can be run via
poetry run pytest
Documentation auto-gen code lives in the /docs folder. Based on the doc strings of public methods, we generate API documentation using pdoc.
To generate the documentation, run:
poe docs-generateOr to build and open the docs preview in one step:
poe docs-previewor poetry run poe docs-preview if you don't have Poe installed yet.
The docs-generate Poe task is mapped to the run() function of docs/generate.py.
Documentation pages will be generated in the docs/generated folder. The test_docs.py test in pytest will automatically update generated content. This updates must be manually committed before docs tests will pass.