This release is a pre-release and may not be stable for production use.
Github source connector
This is the repository for the Github source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.
Local development
Prerequisites
- Python (~=3.9)
- Poetry (~=1.7) - installation instructions here
Installing the connector
From this connector directory, run:
poetry install --with dev
Create credentials
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_github/spec.yaml 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.
Locally running the connector
poetry run source-github spec
poetry run source-github check --config secrets/config.json
poetry run source-github discover --config secrets/config.json
poetry run source-github read --config secrets/config.json --catalog sample_files/configured_catalog.json
Running unit tests
To run unit tests locally, from the connector directory run:
poetry run pytest unit_tests
Building the docker image
- Install
airbyte-ci - Run the following command to build the docker image:
airbyte-ci connectors --name=source-github build
An image will be available on your host with the tag airbyte/source-github:dev.
Running as a docker container
Then run any of the connector commands as follows:
docker run --rm airbyte/source-github:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-github:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-github:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-github:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
Running our CI test suite
You can run our full test suite locally using airbyte-ci:
airbyte-ci connectors --name=source-github test
Customizing acceptance Tests
Customize acceptance-test-config.yml file to configure acceptance 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.
Dependency Management
All of your dependencies should be managed via Poetry. To add a new dependency, run:
poetry add <package-name>
Please commit the changes to pyproject.toml and poetry.lock files.
Publishing a new version of the connector
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
- Make sure your changes are passing our test suite:
airbyte-ci connectors --name=source-github test - Bump the connector version (please follow semantic versioning for connectors):
- bump the
dockerImageTagvalue in inmetadata.yaml - bump the
versionvalue inpyproject.toml
- bump the
- Make sure the
metadata.yamlcontent is up to date. - Make sure the connector documentation and its changelog is up to date (
docs/integrations/sources/github.md). - Create a Pull Request: use our PR naming conventions.
- Pat yourself on the back for being an awesome contributor.
- Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
- Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
1 maintainer
Metadata
1 maintainer
Release files for airbyte-source-github 1.7.1.dev202404071124
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airbyte_source_github-1.7.1.dev202404071124.tar.gz | 226.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airbyte_source_github-1.7.1.dev202404071124-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 473.9 kB
Release files / airbyte_source_github-1.7.1.dev202404071124.tar.gz
| Download URL | airbyte_source_github-1.7.1.dev202404071124.tar.gz |
|---|---|
| Size | 226.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
91fe079eb679d98a4517bc4f733faff8a22e1b32cda35fda6e428d12046e61c7
|
|
BLAKE2b-256 checksum How to use checksums |
605328e4f0eae94f18e28c839d59f48b3dd3ad7d7ef30967ec9eebf2a189f140
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure
|
Release files / airbyte_source_github-1.7.1.dev202404071124-py3-none-any.whl
| Download URL | airbyte_source_github-1.7.1.dev202404071124-py3-none-any.whl |
|---|---|
| Size | 247.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
991e56e4612753542aaa72bc93794049335fa9c92001e495b4681f826b1d2a03
|
|
BLAKE2b-256 checksum How to use checksums |
b4fa7346494d3cf20b4da26a8265d8874fe4d55b5f0c1199e4dea69ebe8feedf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure
|
