Skip to main content

Source implementation for Microsoft OneDrive.

Project description

Microsoft OneDrive source connector

This is the repository for the Microsoft OneDrive 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_microsoft_onedrive/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-microsoft-onedrive spec
poetry run source-microsoft-onedrive check --config secrets/config.json
poetry run source-microsoft-onedrive discover --config secrets/config.json
poetry run source-microsoft-onedrive 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

  1. Install airbyte-ci
  2. Run the following command to build the docker image:
airbyte-ci connectors --name=source-microsoft-onedrive build

An image will be available on your host with the tag airbyte/source-microsoft-onedrive:dev.

Running as a docker container

Then run any of the connector commands as follows:

docker run --rm airbyte/source-microsoft-onedrive:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-onedrive:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-onedrive:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-microsoft-onedrive: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-microsoft-onedrive 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?

  1. Make sure your changes are passing our test suite: airbyte-ci connectors --name=source-microsoft-onedrive test
  2. Bump the connector version (please follow 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 sure the connector documentation and its changelog is up to date (docs/integrations/sources/microsoft-onedrive.md).
  5. Create a Pull Request: use our PR naming conventions.
  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.

Project details


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

File details

Details for the file airbyte_source_microsoft_onedrive-0.2.17.tar.gz.

File metadata

File hashes

Hashes for airbyte_source_microsoft_onedrive-0.2.17.tar.gz
Algorithm Hash digest
SHA256 ceb8cd8620d3da9b7eb3754a77670455c37493f66c14eb53d5c70d50ce2e5478
MD5 221e22038e2abd039aa6b64bcbe1cbf5
BLAKE2b-256 dccb8db90ba17a70797523f5b4dec096dc6678cff9f23e5c65d01a90210b175f

See more details on using hashes here.

File details

Details for the file airbyte_source_microsoft_onedrive-0.2.17-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_source_microsoft_onedrive-0.2.17-py3-none-any.whl
Algorithm Hash digest
SHA256 602106bdcafe41aa41bc4291baf6f13ce0e91b68dc8ea4e0cc5b476480d77421
MD5 a1aec7a2319d74dd7a6a8bd17dc2ac33
BLAKE2b-256 37070e5ed64b56673adec9648293e6cfe8c124395729bd768f624e1b5dc59add

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page