Metadata-Version: 2.1
Name: cardano_explorer
Version: 0.6b0
Summary: Python wrapper for accessing and processing information stored on the Cardano blockchain using Blockfrost API.
Home-page: https://github.com/djessy-atta/py-cardano-explorer
Author: ATTA Djessy
Author-email: djessyatta@live.fr
License: MIT
Download-URL: https://github.com/attadje/py-cardano-explorer/archive/refs/tags/v0.6-beta.0.tar.gz
Keywords: CARDANO,API,WRAPPER,BLOCKCHAIN,BLOCKFROST
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Python Cardano Explorer ![PyPI - Python Version](https://img.shields.io/badge/python-%3E%3D3.8-blue) ![PyPI - Python Version](https://img.shields.io/badge/pypi%20package-v0.6--beta.0-green)

Python wrapper for accessing and processing information stored on the Cardano blockchain using [Blockfrost API](https://blockfrost.io/).

## Install

```python
pip install cardano_explorer
```

## Usage

```python
from cardano_explorer import blockfrost_api
```

## Api Key

If you have an API key, you can either set it as environment variable **BLOCKFROST_API_KEY** or set it manually.

```python
cardano_mainnet = blockfrost_api.Auth()
#or
cardano_mainnet = blockfrost_api.Auth(api_key=api_key)
```

## Using With Proxy

```python
proxies = {
 "http": "http://user:password@server:port",
 "https": "https://user:password@server:portt",
}

cardano_mainnet = blockfrost_api.Auth(proxies=proxies)
```

## Network

You can specify the cardano network with the class parameter **network**.

```python
cardano_mainnet = blockfrost_api.Auth() # mainnet by default
#or
cardano_mainnet = blockfrost_api.Auth(network='mainnet')
#or
cardano_mainnet = blockfrost_api.Auth(network='testnet')
```

## Quickstart

Return detailed about the network.

```python
cardano_mainnet.network_info()
```

    {'supply': {'max': '45000000000000000',
      'total': '33206309572085375',
      'circulating': '32854605043085013',
      'locked': '11030148142156',
      'treasury': '630037263793143',
      'reserves': '11793690427914625'},
     'stake': {'live': '23374530755001598', 'active': '23395112387185878'}}

# Documentation

The official documentation is hosted on [GitHub](https://github.com/djessy-atta/py-cardano-explorer).

# Credit

- [Blockfrost API](https://blockfrost.io/).

# Disclaimer

The project is still under development, If you find bugs or want additional features, open an issue and/or create a pull request.


