forked from airbytehq/airbyte
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ source-stripe: migrate to poetry (airbytehq#35068)
- Loading branch information
1 parent
d2423ca
commit bda8048
Showing
6 changed files
with
1,159 additions
and
92 deletions.
There are no files selected for viewing
100 changes: 57 additions & 43 deletions
100
airbyte-integrations/connectors/source-stripe/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,77 +1,91 @@ | ||
# Stripe Source | ||
# Stripe source connector | ||
|
||
|
||
This is the repository for the Stripe source connector, written in Python. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/stripe). | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/stripe). | ||
|
||
## Local development | ||
|
||
### Prerequisites | ||
**To iterate on this connector, make sure to complete this prerequisites section.** | ||
* Python (~=3.9) | ||
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation) | ||
|
||
#### Minimum Python version required `= 3.7.0` | ||
|
||
#### Build & Activate Virtual Environment and install dependencies | ||
From 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 | ||
### Installing the connector | ||
From this connector directory, run: | ||
```bash | ||
poetry install --with dev | ||
``` | ||
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. | ||
|
||
#### Create credentials | ||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/stripe) | ||
### Create credentials | ||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/stripe) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_stripe/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. | ||
|
||
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source stripe test creds` | ||
and place them into `secrets/config.json`. | ||
|
||
|
||
### Locally running the connector | ||
``` | ||
python main.py spec | ||
python main.py check --config secrets/config.json | ||
python main.py discover --config secrets/config.json | ||
python main.py read --config secrets/config.json --catalog sample_files/configured_catalog.json | ||
poetry run source-stripe spec | ||
poetry run source-stripe check --config secrets/config.json | ||
poetry run source-stripe discover --config secrets/config.json | ||
poetry run source-stripe read --config secrets/config.json --catalog sample_files/configured_catalog.json | ||
``` | ||
|
||
### Unit Tests | ||
### Running unit tests | ||
To run unit tests locally, from the connector directory run: | ||
``` | ||
python -m pytest unit_tests | ||
poetry run pytest unit_tests | ||
``` | ||
|
||
#### Acceptance Tests | ||
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) 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. | ||
To run your integration tests with acceptance tests, from the connector root, run | ||
### Building the docker image | ||
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) | ||
2. Run the following command to build the docker image: | ||
```bash | ||
airbyte-ci connectors --name=source-stripe build | ||
``` | ||
|
||
An image will be available on your host with the tag `airbyte/source-stripe:dev`. | ||
|
||
|
||
### Running as a docker container | ||
Then run any of the connector commands as follows: | ||
``` | ||
docker build . --no-cache -t airbyte/source-stripe:dev \ | ||
&& python -m pytest integration_tests -p integration_tests.acceptance | ||
docker run --rm airbyte/source-stripe:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-stripe:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-stripe:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-stripe:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
## Dependency Management | ||
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. | ||
### Running our CI test suite | ||
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md): | ||
```bash | ||
airbyte-ci connectors --name=source-stripe test | ||
``` | ||
|
||
### Customizing acceptance Tests | ||
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) 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. | ||
|
||
### Publishing a new version of the connector | ||
### Dependency Management | ||
All of your dependencies should be managed via Poetry. | ||
To add a new dependency, run: | ||
```bash | ||
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? | ||
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-stripe test` | ||
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors). | ||
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): | ||
- bump the `dockerImageTag` value in in `metadata.yaml` | ||
- bump the `version` value in `pyproject.toml` | ||
3. Make sure the `metadata.yaml` content is up to date. | ||
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/stripe.md`). | ||
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/stripe.md`). | ||
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention). | ||
6. Pat yourself on the back for being an awesome contributor. | ||
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. | ||
|
||
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.