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
- Import
BlockpipeClient
and create a new instance:
from blockpipe import BlockpipeClient
client = BlockpipeClient('<PROJECT_SLUG>',
environment='production', # optional
base_url='https://app.blockpipe.io/endpoint', # optional
)
- Fetch data from the Blockpipe Endpoint API:
results = client.get(['/path1', '/path2'])
or with a single endpoint
result = client.get('/path1')
- 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
BlockpipeClient
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
License
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.1.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for blockpipe-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0732b649504c62e01ac5bbc41149315c3ed5cb60fb7710886986ad9fe25311d7 |
|
MD5 | 50a1d2217e3f0d3278c177b5a4018398 |
|
BLAKE2b-256 | 790536428e2d9844009379c07500e062a302549f0f55b3e99e8e41025abeeb42 |