Skip to main content

A Python library for interacting with Blockpipe Endpoint API

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 BlockpipeClient and create a new instance:
`from blockpipe_client import BlockpipeClient

client = BlockpipeClient("<PROJECT_SLUG>", {
    "environment": "production",  # optional
    "baseUrl": "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)

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

API

BlockpipeClient

A Python class representing a Blockpipe Client instance.

Constructor:

  • project: The project slug.
  • options (optional): A dictionary with optional configurations:
    • environment: The deployment environment. Default is "production".
    • baseUrl: 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.

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-client-0.1.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blockpipe_client-0.1.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file blockpipe-client-0.1.0.tar.gz.

File metadata

  • Download URL: blockpipe-client-0.1.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for blockpipe-client-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7adb90c588489b48ea79a665bbb0fc331821ae5b46933968960ca3f373d93584
MD5 41f5a4dd41f733fc9ce16e66fb645521
BLAKE2b-256 5b5d16b50300f92fdde25e92b9a4934191fc0400681372efabfba6fed436d091

See more details on using hashes here.

File details

Details for the file blockpipe_client-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for blockpipe_client-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 989b0afdd7a07d97333124c945b9273330c36962558865961d4c0a9c73297615
MD5 b15a8e81d03e04b5e1dc7dd486c805e0
BLAKE2b-256 f075c6160ed9c52df60fa2c90e0d33aeb41735d4fd23e332cac1e016201a9083

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page