Merge branch 'release/0.1.6'

README.md

@@ -8,56 +8,149 @@ PyPI
 pip install pycoingecko
 ```
 or from source
-```
+```bash
+git clone https://github.com/man-c/pycoingecko.git
+cd pycoingecko
 python3 setup.py install
 ```
 
-### Test
-
-Run unit tests with:
-
-```
-# after installing pytest using pip3
-pytest tests
-```
-
 ### Usage
 
-```
+```python
 from pycoingecko import CoinGeckoAPI
 cg = CoinGeckoAPI()
 ```
 
+### Examples
+The required parameters for each endpoint are defined as required (mandatory) parameters for the coresponding functions.
+Optional parameters can be also passed using same names, as defined in CoinGecko API doc (https://www.coingecko.com/api/docs/v3)
+
+Usage examples:
+```python
+# /simple/price endpoint with the required parameters
+>>> cg.get_price(ids='bitcoin', vs_currencies='usd')
+{'bitcoin': {'usd': 3462.04}}
+
+>>> cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd')
+{'bitcoin': {'usd': 3461.27}, 'ethereum': {'usd': 106.92}, 'litecoin': {'usd': 32.72}}
+
+>>> cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd,eur')
+{'bitcoin': {'usd': 3459.39, 'eur': 3019.33}, 'ethereum': {'usd': 106.91, 'eur': 93.31}, 'litecoin': {'usd': 32.72, 'eur': 28.56}}
+
+# optional parameteres can be passed as defined in the API doc (https://www.coingecko.com/api/docs/v3)
+>>> cg.get_price(ids='bitcoin', vs_currencies='usd',include_market_cap='true',include_24hr_vol='true',include_24hr_change='true',include_last_updated_at='true')
+{'bitcoin': {'usd': 3458.74, 'usd_market_cap': 60574330199.29028, 'usd_24h_vol': 4182664683.6247883, 'usd_24h_change': 1.2295378479069035, 'last_updated_at': 1549071865}}
+```
+
 ### API documentation
 https://www.coingecko.com/api/docs/v3
 
 ### Endpoints included
 - ping
   - /ping (Check API server status)
+    ```python 
+    cg.ping()
+    ```
 - simple
   - /simple/price (Get the current price of any cryptocurrencies in any other supported currencies that you need)
+    ```python 
+    cg.get_price()
+    ```
   - /simple/supported_vs_currencies (Get list of supported_vs_currencies)
+    ```python 
+    cg.get_supported_vs_currencies()
+    ```
 - coins
   - /coins/list (List all supported coins id, name and symbol (no pagination required))
+  ```python 
+    cg.get_coins_list()
+    ```
   - /coins/markets (List all supported coins price, market cap, volume, and market related data (no pagination required))
+  ```python 
+    cg.get_coins_markets()
+    ```
   - /coins/{id} (Get current data (name, price, market, ... including exchange tickers) for a coin)
+  ```python 
+    cg.get_coin_by_id()
+    ```
   - /coins/{id}/tickers (Get coin tickers (paginated to 100 items))
+  ```python 
+    cg.get_coin_ticker_by_id()
+    ```
   - /coins/{id}/history (Get historical data (name, price, market, stats) at a given date for a coin)
+  ```python 
+    cg.get_coin_history_by_id()
+    ```
   - /coins/{id}/market_chart (Get historical market data include price, market cap, and 24h volume (granularity auto))
+  ```python 
+    cg.get_coin_market_chart_by_id()
+    ```
   - /coins/{id}/status_updates (Get status updates for a given coin (beta))
+  ```python 
+    cg.get_coin_status_updates_by_id()
+    ```
   - /coins/{id}/contract/{contract_address} (Get coin info from contract address)
+  ```python 
+    cg.get_coin_info_from_contract_address_by_id()
+    ```
 - exchanges (beta)
   - /exchanges (List all exchanges)
+  ```python
+  cg.get_exchanges_list()
+  ```
+  - /exchanges/list (List all supported markets id and name (no pagination required))
+  ```python
+  cg.get_exchanges_id_name_list()
+  ```
   - /exchanges/{id} (Get exchange volume in BTC and top 100 tickers only)
+  ```python
+  cg.get_exchanges_by_id()
+  ```
   - /exchanges/{id}/tickers (Get exchange tickers (paginated))
+  ```python
+  cg.get_exchanges_tickers_by_id()
+  ```
   - /exchanges/{id}/status_updates (Get status updates for a given exchange (beta))
+  ```python
+  cg.get_exchanges_status_updates_by_id()
+  ```
 - status_updates (beta)
   - /status_updates (List all status_updates with data (description, category, created_at, user, user_title and pin))
+  ```python
+  cg.get_status_updates()
+  ```
 - events
   - /events (Get events, paginated by 100)
+  ```python
+  cg.get_events()
+  ```
   - /events/countries (Get list of event countries)
+  ```python
+  cg.get_events_countries()
+  ```
   - /events/types (Get list of events types)
+  ```python
+  cg.get_events_types()
+  ```
 - exchange_rates
   - /exchange_rates (Get BTC-to-Currency exchange rates)
+  ```python
+  cg.get_exchange_rates()
+  ```
 - global
   - /global (Get cryptocurrency global data)
+  ```python
+  cg.get_global()
+  ```
+
+### Test
+
+Run unit tests with:
+
+```
+# after installing pytest using pip3
+pytest tests
+```
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

pycoingecko/api.py

@@ -162,6 +162,14 @@ def get_exchanges_list(self):
         return self.__request(api_url)
 
 
+    def get_exchanges_id_name_list(self):
+        """List all supported markets id and name (no pagination required)"""
+
+        api_url = '{0}exchanges/list'.format(self.api_base_url)
+
+        return self.__request(api_url)
+
+
     def get_exchanges_by_id(self, id):
         """Get exchange volume in BTC and tickers"""
 

setup.py

@@ -3,15 +3,15 @@
 
 setuptools.setup(
     name='pycoingecko',
-    version='0.1.4',
+    version='0.1.6',
     packages=['pycoingecko',],
     license='MIT',
     description = 'Python wrapper around the CoinGecko API',
-    long_description=open('long_description.md').read(),
+    long_description=open('README.md').read(),
     long_description_content_type="text/markdown",
     author = 'Christoforou Manolis',
     author_email = '[email protected]',
-    install_requires=['requests', 'pytest', 'responses'],
+    install_requires=['requests'],
     url = 'https://github.com/man-c/pycoingecko',
     classifiers=[
         "Programming Language :: Python :: 3",