Metadata-Version: 2.1
Name: karpet
Version: 0.2.1
Summary: Library for fetching coin/token metrics data from the internet.
Home-page: https://github.com/im-n1/karpet
Author: n1
Author-email: hrdina.pavel@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/im-n1/karpet/issues
Project-URL: Documentation, https://github.com/im-n1/karpet
Project-URL: Source Code, https://github.com/im-n1/karpet
Description: .. image:: https://raw.githubusercontent.com/im-n1/karpet/master/assets/logo.png
           :align: center
        
        .. image:: https://img.shields.io/pypi/v/karpet.svg?color=0c7dbe
           :alt: PyPI
        
        .. image:: https://img.shields.io/pypi/l/karpet.svg?color=0c7dbe
           :alt: PyPI - License
        
        .. image:: https://img.shields.io/pypi/dm/karpet.svg?color=0c7dbe
           :alt: PyPI - Downloads
        
        Karpet
        ======
        Karpet is a tiny library with just a few dependencies
        for fetching coins/tokens metrics data the internet.
        
        It can provide following data:
        
        * coin/token historical price data (no limits)
        * google trends for the given list of keywords (longer period than official API)
        * twitter scraping for the given keywords (no limits)
        * much more info about crypto coins/tokens (no rate limits)
        
        What is upcoming?
        
        * Reddit metrics
        * Have a request? Open an issue ;)
        
        Dependencies
        ------------
        Library uses a few nifty dependencies and is Python 3.6+ only. There is no
        need to install dependencies you don't need. Therefore this library utilizes
        extras which install optional dependencies:
        
        * for Google trends - google
        * for Twitter scraping - twitter
        
        Usage
        -----
        
        Install the library via pip.
        
        .. code-block::
        
           ~ pip install karpet  # Basics only
           ~ pip install karpet[twitter]  # For Twitter scraping
           ~ pip install karpet[google]  # For Google trends
           ~ pip install karpet[twitter,google]  # All features
        
        Import the library class first.
        
        .. code-block::
        
            from karpet.karpet import Karpet
        
        Symbol (ticker) -> coninmarketcap.com URL slug conversion.
        
        .. code-block::
        
            c = Karpet()
            c.get_coin_slug("BTC")  # bitcoin
        
        Retrieving historical data.
        
        .. code-block::
        
            c = Karpet(date(2019, 1, 1), date(2019, 5, 1))
            df = c.fetch_crypto_historical_data(coin="bitcoin")  # Dataframe with historical data
            df.head()
        
        .. image:: https://raw.githubusercontent.com/im-n1/karpet/master/assets/historical_data.png
        
        Retrieving exchange list.
        
        .. code-block::
        
            c = Karpet()
            c.fetch_exchanges("nrg")  # ['DigiFinex', 'KuCoin', 'CryptoBridge', 'Bitbns', 'CoinExchange']
        
        Retrieving twitter tweets.
        
        .. code-block::
        
            c = Karpet(date(2019, 1, 1), date(2019, 5, 1))
            df = c.fetch_tweets(kw_list=["bitcoin"], lang="en")  # Dataframe with tweets.
            df.head()
        
        .. image:: https://raw.githubusercontent.com/im-n1/karpet/master/assets/tweets.png
        
        Retrieving Google Trends - in percents for the given date range.
        
        .. code-block::
        
            c = Karpet(date(2019, 1, 1), date(2019, 5, 1))
            df = c.fetch_google_trends(kw_list=["bitcoin"])  # Dataframe with trends.
            df.head()
        
        .. image:: https://raw.githubusercontent.com/im-n1/karpet/master/assets/google_trends.png
        
        And with a few lines of code you can get a chart
        
        .. code-block::
        
           df = df.set_index("date")
           df.plot()
        
        .. image:: https://raw.githubusercontent.com/im-n1/karpet/master/assets/trends_chart.png
        
        Changelog
        ---------
        
        0.2.1
        ~~~~~
        * Added ``fetch_exchanges()`` method for retrieving symbol exchange list.
        * Removed obsolete library dependency.
        
        0.2
        ~~~
        * Twitter scraping added.
        
        0.1
        ~~~
        * Initial release.
        
        Credits
        -------
        This is my personal library I use in my long-term project. I can pretty much guarantee it will
        live for a long time then. I will add new features over time and I more than welcome any
        help or bug reports. Feel free to open an issue or merge request.
        
        The code is is licensed under MIT license.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.6
Provides-Extra: twitter
Provides-Extra: google
