Skip to main content

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

Metadata

Release files for blockpipe 0.1.3

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

Source distribution (sdist)

Source distribution for blockpipe 0.1.3
File Size Uploaded Provenance Actions
blockpipe-0.1.3.tar.gz 5.8 kB Without provenance Details for blockpipe-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for blockpipe 0.1.3
File Interpreter ABI Platform Actions
blockpipe-0.1.3-py3-none-any.whl Python 3 none any Details for blockpipe-0.1.3-py3-none-any.whl

Total release size: 12.1 kB

Release files / blockpipe-0.1.3.tar.gz

Download URL blockpipe-0.1.3.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d41fd8008b29cd70dc0fc4357252668e4adc4ab17e478bd2c3ff4b7232356826
BLAKE2b-256 checksum
How to use checksums
90b890b63a2aba4ec07d472574c844914baf66f2b1133b590e1a4722c0e55dfe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.11.2 Darwin/22.4.0

Release files / blockpipe-0.1.3-py3-none-any.whl

Download URL blockpipe-0.1.3-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
01ab495db29bf8fd0b4b84751a3e5a5b7b1045a4957dcc83cd81e39dbb8a674d
BLAKE2b-256 checksum
How to use checksums
d1d0524cab604fd51dfc3e3d3a5547d774e726ba3bcabec2fe8416e8a58fc1da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.11.2 Darwin/22.4.0

Security for blockpipe 0.1.3

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