| Name | airbyte-source-posthog JSON |
| Version |
1.1.20
JSON |
| download |
| home_page | https://airbyte.com |
| Summary | Source implementation for Posthog. |
| upload_time | 2024-12-22 02:52:14 |
| maintainer | None |
| docs_url | None |
| author | Airbyte |
| requires_python | <3.12,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PostHog Source
This is the repository for the PostHog source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/posthog).
## Local development
### Prerequisites
* Python (`^3.9`)
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
### Installing the connector
From this connector directory, run:
```bash
poetry install --with dev
```
### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/posthog)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_posthog/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 posthog test creds`
and place them into `secrets/config.json`.
### Locally running the connector
```
poetry run source-posthog spec
poetry run source-posthog check --config secrets/config.json
poetry run source-posthog discover --config secrets/config.json
poetry run source-posthog read --config secrets/config.json --catalog sample_files/configured_catalog.json
```
### 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-posthog build
```
An image will be available on your host with the tag `airbyte/source-posthog:dev`.
### Running as a docker container
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-posthog:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-posthog:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-posthog:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-posthog:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json
```
### 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-posthog test
```
### Customizing acceptance Tests
Customize `acceptance-test-config.yml` file to configure 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.
## 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.
We split dependencies between two groups, dependencies that are:
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
### 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-posthog 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).
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/posthog.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.
Raw data
{
"_id": null,
"home_page": "https://airbyte.com",
"name": "airbyte-source-posthog",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Airbyte",
"author_email": "contact@airbyte.io",
"download_url": "https://files.pythonhosted.org/packages/95/a8/a579692810b1d585bac07d3179c6e9aff76d069dbd0dbf9d02c32bd9339b/airbyte_source_posthog-1.1.20.tar.gz",
"platform": null,
"description": "# PostHog Source\n\nThis is the repository for the PostHog source connector, written in Python.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/posthog).\n\n## Local development\n\n### Prerequisites\n\n* Python (`^3.9`)\n* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)\n\n### Installing the connector\n\nFrom this connector directory, run:\n```bash\npoetry install --with dev\n```\n\n### Create credentials\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/posthog)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_posthog/spec.json` file.\nNote that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.\nSee `sample_files/sample_config.json` for a sample config file.\n\n**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source posthog test creds`\nand place them into `secrets/config.json`.\n\n### Locally running the connector\n\n```\npoetry run source-posthog spec\npoetry run source-posthog check --config secrets/config.json\npoetry run source-posthog discover --config secrets/config.json\npoetry run source-posthog read --config secrets/config.json --catalog sample_files/configured_catalog.json\n```\n\n### Building the docker image\n\n1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)\n2. Run the following command to build the docker image:\n```bash\nairbyte-ci connectors --name=source-posthog build\n```\n\nAn image will be available on your host with the tag `airbyte/source-posthog:dev`.\n\n### Running as a docker container\n\nThen run any of the connector commands as follows:\n\n```\ndocker run --rm airbyte/source-posthog:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-posthog:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-posthog:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-posthog:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json\n```\n\n### Running our CI test suite\n\nYou can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):\n```bash\nairbyte-ci connectors --name=source-posthog test\n```\n\n### Customizing acceptance Tests\n\nCustomize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.\nIf 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.\n\n## Dependency Management\n\nAll 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.\nWe split dependencies between two groups, dependencies that are:\n\n- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.\n- required for the testing need to go to `TEST_REQUIREMENTS` list\n\n### Publishing a new version of the connector\n\nYou've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?\n\n1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-posthog test`\n2. 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).\n3. Make sure the `metadata.yaml` content is up to date.\n4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/posthog.md`).\n5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).\n6. Pat yourself on the back for being an awesome contributor.\n7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Source implementation for Posthog.",
"version": "1.1.20",
"project_urls": {
"Documentation": "https://docs.airbyte.com/integrations/sources/posthog",
"Homepage": "https://airbyte.com",
"Repository": "https://github.com/airbytehq/airbyte"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d70d00c1a59d4245bd21b129880947c3f78061ab0ef66bef3639f6a4eca198df",
"md5": "d5fd8edfb96ff256d161bdf31ba4f182",
"sha256": "611f79417076be1b050e14dd0b11498620af3a9de7eba4f9c1a8bfcbf1029857"
},
"downloads": -1,
"filename": "airbyte_source_posthog-1.1.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5fd8edfb96ff256d161bdf31ba4f182",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 11634,
"upload_time": "2024-12-22T02:52:12",
"upload_time_iso_8601": "2024-12-22T02:52:12.373542Z",
"url": "https://files.pythonhosted.org/packages/d7/0d/00c1a59d4245bd21b129880947c3f78061ab0ef66bef3639f6a4eca198df/airbyte_source_posthog-1.1.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95a8a579692810b1d585bac07d3179c6e9aff76d069dbd0dbf9d02c32bd9339b",
"md5": "8b3075c8798de566c40128dffb9f4250",
"sha256": "9142445863714d9ad2890ca8acbcab6917440670a576eb2c258557517d25f678"
},
"downloads": -1,
"filename": "airbyte_source_posthog-1.1.20.tar.gz",
"has_sig": false,
"md5_digest": "8b3075c8798de566c40128dffb9f4250",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 9411,
"upload_time": "2024-12-22T02:52:14",
"upload_time_iso_8601": "2024-12-22T02:52:14.542655Z",
"url": "https://files.pythonhosted.org/packages/95/a8/a579692810b1d585bac07d3179c6e9aff76d069dbd0dbf9d02c32bd9339b/airbyte_source_posthog-1.1.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 02:52:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "airbytehq",
"github_project": "airbyte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "airbyte-source-posthog"
}
