No project description provided
Project description
OnePlan SDK
This repo provides a python SDK for the OnePlan API.
Why
We interact with the OnePlan API increasingly, especially as we migrate to our GCP cloud data platform.
The OnePlan team does not provide an OpenAPI 3.0 spec or a python client. The team does provide autogenerated documentation, which is available here.
In order to ensure that we interact with the OnePlan API consistently with well-tested and documented code, this package provides the following functionality:
- continuously sync with the up-to-date OnePlan API docs pages
- auto-generate an OpenAPI 3.0 specification document based on the contents of the OnePlan API docs
- auto-generate a fully documented and tested python client against the OpenAPI 3.0 specification
Setup
For developer setup instructions, please see SETUP.md
Usage
For usage instructions, please see USAGE.md
Workflow and Tests
For details on the inner workings synchronization and auto-generation workflows and related unit tests, see WORKFLOW.md.
TO-DOs:
- Logging
- Workflow rules and related unit tests / validation code
- [Optional] Scheduling
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
File details
Details for the file oneplan_sdk-0.1.0.tar.gz
.
File metadata
- Download URL: oneplan_sdk-0.1.0.tar.gz
- Upload date:
- Size: 319.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-41-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aeb2ac42cdd049ec645ce0fe0ee69da20f4dcaf7f89207f7781cff8d6633fbe |
|
MD5 | b13c88d02e61a6e3b06346e1b84f64af |
|
BLAKE2b-256 | 0f5ad968b68fb191116f5c340a16b329a603328fbf64206a6e944254d61c50ca |
File details
Details for the file oneplan_sdk-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: oneplan_sdk-0.1.0-py3-none-any.whl
- Upload date:
- Size: 794.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-41-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d946289f994bbd8d5a83b176405ce183fc93a111e3e02f30e19d180ce0ac03e |
|
MD5 | 7517f48c262298324686cfad780bcdbb |
|
BLAKE2b-256 | 28a2da9058928cc3deb182e250e2e72b70749a771967580914d23670a153857f |