Skip to content

Commit

Permalink
[ISSUE #20044] code review
Browse files Browse the repository at this point in the history
  • Loading branch information
maxi297 committed Dec 15, 2022
1 parent 8ff3c5e commit 4471266
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions airbyte-cdk/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ pip install -e ".[dev]" # [dev] installs development-only dependencies
* Perform static type checks using `mypy airbyte_cdk`. `MyPy` configuration is in `.mypy.ini`.
* The `type_check_and_test.sh` script bundles both type checking and testing in one convenient command. Feel free to use it!

##### Autogenerated files
If the iteration you are working on includes changes to the models, you might want to regenerate them. In order to do that, you can run:
```commandline
SUB_BUILD=CONNECTORS_BASE ./gradlew format --scan --info --stacktrace
```
This will generate the files based on the schemas, add the license information and format the code. If you want to only do the former and rely on pre-commit to the others, you can run the appropriate generation command i.e. `./gradlew generateProtocolClassFiles` or `./gradlew generateComponentManifestClassFiles`.

#### Testing

All tests are located in the `unit_tests` directory. Run `pytest --cov=airbyte_cdk unit_tests/` to run them. This also presents a test coverage report.
Expand Down

0 comments on commit 4471266

Please sign in to comment.