Skip to main content

No project description provided

Project description

Blockpipe Client for Python

Blockpipe Client is a Python library for interacting with Blockpipe Endpoint API. It provides a simple interface for fetching data from the API and supports both single endpoint and multiple endpoints.

Installation

Install the package using pip:

pip install blockpipe

Usage

  1. Import Client and create a new instance:
from blockpipe import Client

client = Client('<PROJECT_SLUG>', 
    environment='production', # optional
    base_url='https://app.blockpipe.io/endpoint', # optional
)
  1. Fetch data from the Blockpipe Endpoint API:
results = client.get(['/path1', '/path2'])

or with a single endpoint

result = client.get('/path1')
  1. Use the fetched data in your application:
for result in results:
    print(result['data'])

# If you only requested one endpoint, you can access the data directly:
print(result['data'])

API

Client

A Python class representing a Blockpipe Client instance.

Constructor:

  • project: The project slug.
  • environment (optional): The deployment environment. Default is 'production'.
  • base_url (optional): The base URL for the API. Default is 'https://app.blockpipe.io/endpoint'.

get

A method to fetch data from one or multiple Blockpipe Endpoint API paths.

Arguments:

  • endpoints: A list of endpoint paths or a single endpoint path as a string.

Returns:

A list of data fetched from the specified endpoints, or a single data object if a single endpoint path was provided.

Developer Notes

Building the Package

poetry build

Publishing the Package

poetry publish # OR
poetry publish --username __token__ --password [PYPI_TOKEN]

License

Apache 2.0

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

blockpipe-0.1.3.tar.gz (5.8 kB view hashes)

Uploaded source

Built Distribution

blockpipe-0.1.3-py3-none-any.whl (6.3 kB view hashes)

Uploaded py3

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