Metadata-Version: 2.1
Name: coindesk
Version: 1.0.0
Summary: Bitcoin current and historical price
Home-page: https://github.com/sdediego/coindesk-api-client
Author: Sergio de Diego
Author-email: sergiodediego@outlook.com
License: MIT
Download-URL: https://github.com/sdediego/coindesk-api-client/archive/v1.0.0-alpha.tar.gz
Description: # CoinDesk API client
        
        Powered by [![CoinDesk]()](https://www.coindesk.com/api/)
        
        Client written in Python3 for CoinDesk API service.
        
        ### Features
        
          - Get Bitcoin current price
          - Get Bitcoin historical price
        
        ### Getting Started
        
        These instructions will get you a copy of the project on your local system.
        
        #### Dependencies
        
        CoinDesk API client uses a number of open source projects to work properly:
        
        * [aiohttp] - Asynchronous HTTP client/server for asyncio and Python
        * [furl] - URL parsing and manipulation made easy
        * [jsonschema] - An implementation of JSON Schema validation for Python
        * [requests] - Python HTTP for Humans
        
        And of course CoinDesk API client itself is open source with a [public repository][coindesk-api-client] on GitHub.
        
        #### Installation
        
        Intall the package from [Pypi][pypi] using the command:
        ```sh
        pip install -U coindesk
        ```
        
        #### Quick Start
        
        A series of simple examples:
        
        Get currentprice price for Bitcoin in json format
        ```python
        from coindesk.client import CoindeskAPIClient
        api_client = CoindeskAPIClient.start('currentprice')
        response = api_client.get()
        ```
        
        Get currentprice price for Bitcoin in other currency than USD
        ```python
        from coindesk.client import CoindeskAPIClient
        api_client = CoindeskAPIClient.start('currentprice', {'currency': 'EUR'})
        response = api_client.get()
        ```
        
        Get historical price for Bitcoin in json format
        ```python
        from coindesk.client import CoindeskAPIClient
        api_client = CoindeskAPIClient.start('historical')
        response = api_client.get()
        ```
        
        Get historical price for Bitcoin providing optional parameters
        ```python
        from coindesk.client import CoinDeskAPIClient
        api_client = CoindeskAPIClient.start('historical', {'currency': 'EUR', 'for': 'yesterday'})
        response = api_client.get()
        ```
        
        Make a request with custom parameters either for currentprice or historical
        ```python
        from coindesk.client import CoinDeskAPIClient
        api_client = CoindeskAPIClient.start('currentprice', retries=5, redirects=False, timeout=10)
        response = api_client.get()
        ```
        
        Get raw http response either for currentprice or historical
        ```python
        from coindesk.client import CoinDeskAPIClient
        api_client = CoindeskAPIClient.start('currentprice')
        response = api_client.get(raw=True)
        ```
        
        Get supported currencies to fetch Bitcoin price in
        ```python
        from coindesk.client import CoindeskAPIClient
        api_client = CoindeskAPIClient()
        supported_currencies = api_client.get_supported_currencies()
        ```
        
        Full documentation for CoinDesk API is available at https://www.coindesk.com/api/.
        
        License
        ----
        
        MIT
        
        **Free Software. Hell Yeah!**
        
        [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
        
           [coindesk-api-client]: <https://github.com/sdediego/coindesk-api-client>
           [pypi]: <https://pypi.org/project/coindesk/>
           [aiohttp]: <https://github.com/aio-libs/aiohttp>
           [furl]: <https://github.com/gruns/furl>
           [jsonschema]: <https://github.com/Julian/jsonschema>
           [requests]: <https://github.com/requests/requests>
        
Keywords: api asynchronous Bitcoin blockchain client Coindesk Python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
