Skip to content

jhhb/pydefipulsedata

Repository files navigation

Overview

PyPI Version PyPI License Documentation

An unofficial Python SDK for the DeFi Pulse Data project and each of its partner service providers. This project provides a lightweight Python client for each service provider.

Currently, the DeFi Pulse Data service providers include:

The goals of this package are to empower Python programmers to make use of DeFi Pulse Data services, to enrich the broader DeFi developer ecosystem, and to reduce overall developer effort by providing a packaged developer SDK so that developers do not need to reinvent the wheel for each project they make.

This project bears no official relationship to the DeFi Pulse Data project, or the Concourse Open Community project.

Setup

Requirements

  • Python 3.7+

Installation

Install it directly into an activated virtual environment:

$ pip install defipulsedata

or add it to your Poetry project:

$ poetry add defipulsedata

Usage

After installation, the package can imported.

Each module below corresponds to a single, logical data provider service defined in the DeFi Pulse Data documentation.

from defipulsedata import RekTo, EthGasStation, DefiPulse, DexAg, PoolsFyi

key='REPLACE-WITH-YOUR-KEY'

# Example requests for each client.

# Rek.to
rekto = RekTo(api_key=key)
rekto.get_events()

# DeFi Pulse
dp = DefiPulse(api_key=key)
dp.get_projects()

# ETH Gas Station
egs = EthGasStation(api_key=key)
egs.get_gas_price()

# DEX.AG
dexag = DexAg(api_key=key)
dexag.get_markets()

# Pools.Fyi
pools = PoolsFyi(api_key=key)
pools.get_exchanges()

Contributing and Filing Issues

Details for local development dependencies and useful Make targets can be found in here

Contributions, suggestions, bug reports, are welcome and encouraged.

If you have a bug or issue, please file a GitHub issue on the project describing the expected behavior and the actual behavior, with steps to reproduce the issue.

If you have a feature request, please file a GitHub issue on the project describing the feature you want, and why you want it.

License

The MIT License (MIT)

Copyright © 2021, James Boyle

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases

No releases published

Packages

No packages published