Skip to main content

BuiltOn Python SDK

Python SDK for the BuiltOn APIs

PyPI PyPI - Status PyPI - Downloads Downloads

Builton logo

BuiltOn offers a platform as a service that digitizes core business functions and optimizes resource allocation with baked-in machine learning capabilities. This package gives you access to our platform's building blocks and will help you implement its API. Get instant access to modules like Payments, Messaging Tools, User Management, Scheduling, Resource Allocation and more.

Documentation

See the BuiltOn API documentation for a full reference of the API or visit our website - https://builton.dev - if you want to create an account.

Getting Started

Prerequisites

This package has been fully tested using Python 3.6, but it's expected to work in all Python 3+ versions.

Installation

To install the package use pip as usual:

pip install builton-sdk

To install from source use:

python setup.py install

Usage

from builton_sdk import Builton
builton = Builton(api_key="API_KEY", bearer_token="BEARER_TOKEN")
builton.product().get_all(size=1)

The API_KEY and the BEARER_TOKEN are both in the Settings section of your BuiltOn dashboard. The API_KEY will be under API Keys and if you don't have one yet, please go ahead and create it. The BEARER_TOKEN you can fetch from the Service Accounts section, from an existing Service Account or by creating a new one.

Contributing

Configuration

Before starting to use the package, please copy the config.py.template into config.py and edit the configuration inside accordingly. Have a look at the Usage section for more information on how to find the values to put inside the config.py.

Testing

Our test suite depends heavily on talkback to mock some of the API responses. So, in order to contribute you'll need to first have node.js and npm installed and then you can run the following script to start the talkback server:

./tests/integration/scripts/run_server.sh

After the server starts, you can put it in background and then run the tests:

pytest tests/

Pushing Changes

Follow the steps below to open a new Pull Request into this package:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b amazing-feature)
  3. Commit your Changes (git commit -m 'Add some Amazing Feature')
  4. Push to the Branch (git push origin amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT license. See the LICENSE file for more info.

Contact

Please use the github issues for problems you find with the package or suggestions for changes.

If you need to get in touch with anyone from our team please email us at hello@builton.dev

Metadata

Release files for builton-sdk 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for builton-sdk 0.3.1
File Size Uploaded Provenance Actions
builton-sdk-0.3.1.tar.gz 15.0 kB Without provenance Details for builton-sdk-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for builton-sdk 0.3.1
File Interpreter ABI Platform Actions
builton_sdk-0.3.1-py3-none-any.whl Python 3 none any Details for builton_sdk-0.3.1-py3-none-any.whl

Total release size: 46.8 kB

Release files / builton-sdk-0.3.1.tar.gz

Download URL builton-sdk-0.3.1.tar.gz
Size 15.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9075369737143e1c1e184f361a834a0c3a6c47e00cfc05d9b6e5a4c22c3aec89
BLAKE2b-256 checksum
How to use checksums
60ca2225b3da32f5cbeb76e92d006ae55c454da00da3a8f9ea3c7a6a606b8606
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

Release files / builton_sdk-0.3.1-py3-none-any.whl

Download URL builton_sdk-0.3.1-py3-none-any.whl
Size 31.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8d07821b378e4ceeb78385fe27a5ea36a1b2675fbca2e4e260e1a097106ec852
BLAKE2b-256 checksum
How to use checksums
99bfcda3da792bac37640c8b97fa73ed067d92e136ba2018daa6289a4c6f23f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

Security for builton-sdk 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page