airbyte-integrations/connectors/source-python-http-tutorial/README.md
This is the repository for the Python Http Tutorial source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.
To iterate on this connector, make sure to complete this prerequisites section.
= 3.7.0From this connector directory, create a virtual environment:
python -m venv .venv
This will generate a virtualenv for this module in .venv/. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
source .venv/bin/activate
pip install -r requirements.txt
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
Note that while we are installing dependencies from requirements.txt, you should only edit setup.py for your dependencies. requirements.txt is
used for editable installs (pip install -e) to pull in Python dependencies from the monorepo and will call setup.py.
If this is mumbo jumbo to you, don't worry about it, just put your deps in setup.py but install using pip install -r requirements.txt and everything
should work as you expect.
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
To build using Gradle, from the Airbyte repository root, run:
./gradlew :airbyte-integrations:connectors:source-python-http-tutorial:build
If you are a community contributor, follow the instructions in the documentation
to generate the necessary credentials. Then create a file secrets/config.json conforming to the source_python_http_tutorial/spec.json file.
Note that any directory named secrets is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See sample_files/sample_config.json for a sample config file.
If you are an Airbyte core member, copy the credentials in Lastpass under the secret name source python-http-tutorial test creds
and place them into secrets/config.json.
python main.py spec
python main.py check --config sample_files/config.json
python main.py discover --config sample_files/config.json
python main.py read --config sample_files/config.json --catalog sample_files/configured_catalog.json
To run unit tests locally, from the connector directory run:
python -m pytest unit_tests
Via airbyte-ci (recommended):
airbyte-ci connectors --name=source-python-http-tutorial build
An image will be built with the tag airbyte/source-python-http-tutorial:dev.
Via docker build:
docker build -t airbyte/source-python-http-tutorial:dev .
Then run any of the connector commands as follows:
docker run --rm airbyte/source-python-http-tutorial:dev spec
docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/source-python-http-tutorial:dev check --config /sample_files/config.json
docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/source-python-http-tutorial:dev discover --config /sample_files/config.json
docker run --rm -v $(pwd)/sample_files:/sample_files -v $(pwd)/sample_files:/sample_files airbyte/source-python-http-tutorial:dev read --config /sample_files/config.json --catalog /sample_files/configured_catalog.json
You can run our full test suite locally using airbyte-ci:
airbyte-ci connectors --name=source-python-http-tutorial test
Customize acceptance-test-config.yml file to configure tests. See Connector Acceptance Tests for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
All of your dependencies should go in setup.py, NOT requirements.txt. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
airbyte-ci connectors --name=source-python-http-tutorial testmetadata.yaml: increment the dockerImageTag value. Please follow semantic versioning for connectors.metadata.yaml content is up to date.docs/integrations/sources/python-http-tutorial.md).