Source implementation for Posthog.
Project description
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.
Local development
Prerequisites
To iterate on this connector, make sure to complete this prerequisites section.
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
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
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
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
Locally running the connector docker image
Build
Via airbyte-ci
(recommended):
airbyte-ci connectors --name=source-posthog build
An image will be built with the tag airbyte/source-posthog:dev
.
Via docker build
:
docker build -t airbyte/source-posthog:dev .
Run
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
Testing
You can run our full test suite locally using airbyte-ci
:
airbyte-ci connectors --name=source-posthog test
Customizing acceptance Tests
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.
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?
- Make sure your changes are passing our test suite:
airbyte-ci connectors --name=source-posthog test
- Bump the connector version in
metadata.yaml
: increment thedockerImageTag
value. Please follow semantic versioning for connectors. - Make sure the
metadata.yaml
content is up to date. - Make the connector documentation and its changelog is up to date (
docs/integrations/sources/posthog.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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for airbyte_source_posthog-1.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1ca8b1a53fa84100f7ef4c937d80f5cbc41ce2502546156dd71851e10383c81 |
|
MD5 | 6c5e6eb05f79da34e346f8e652bb8407 |
|
BLAKE2b-256 | 00f7be93d727934750a4e78c0da0279466fe1de78532db77f96813f7d09fed3e |
Hashes for airbyte_source_posthog-1.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f562454cea397bd529605b92705ce14df160471121da87842401ed2e7270f744 |
|
MD5 | 171fb1f4e1b350afe96db8d9b8210528 |
|
BLAKE2b-256 | e06bf86cdd675e9cfb73d5a946d96c4a4b0a4665489044d4d5ab3f815162cfc1 |