Metadata-Version: 1.1
Name: twpy
Version: 1.2.1
Summary: Twitter High level scraper for humans. 
Home-page: https://github.com/0x0ptim0us/twpy
Author: Fardin Allahverdinazhand
Author-email: 0x0ptim0us@gmail.com
License: MIT
Download-URL: https://github.com/0x0ptim0us/twpy/tarball/1.2.1
Description: Twpy
        ========
        
        Twitter High level scraper for humans.
        
        
        Features
        --------
        - NO LIMIT, NO API required
        - Fast and easy to use
        - Working with python 3.5+
        - Integrated with pandas for data science research
        
        
        Installation
        ------------
        Manual install via git :
        
        .. code-block:: bash
        
            $ git clone https://github.com/0x0ptim0us/twpy.git
            $ cd twpy
            $ python setup.py install
        
        
        Install using pip:
        
        .. code-block:: bash
        
            $ pip install twpy
            # or
            $ python -m pip install twpy
        
        
        Usage
        --------
        
        Guidance of using Twpy :
        
        
        .. code-block:: python
        
            >>> from twpy import TwpyClient
            >>> from twpy.serializers import to_pandas
            >>>
            >>> # create twpy client object
            >>> tc = TwpyClient()
        
        
        
        Get twpy current version :
        
        .. code-block:: python
        
            >>> tc.__version__
            '1.2.1'
        
        
        Get user followers:
        
        .. code-block:: python
        
            >>> # get user followers, limited up to 50
            >>> # interval : delay between each request, default is 0 for no delay
            >>> # proxy : send traffic through proxy, default is none
            >>> followers_data = tc.get_followers(username="elonmusk", limit=50, proxy="127.0.0.1:8080", interval=1)
        
        
        Get user timeline:
        
        .. code-block:: python
        
            >>> tweets = tc.get_timeline(username="elonmusk", limit=50)
        
        
        Get user profile:
        
        .. code-block:: python
        
            >>> user_info = tc.get_user(username="elonmusk")
        
        
        
        Convert result object to other data structures :
        
        .. code-block:: python
        
            >>> # convert result to pandas data frame, json and list
            >>> # pandas
            >>> pandas_sample = to_pandas(followers_data)
            >>> # json
            >>> json_sample = to_json(followers_data)
            >>> # list
            >>> list_sample = to_list(followers_data)
        
        
        Search example:
        
        .. code-block:: python
        
        
            >>> # search user tweets until 2015
            >>> tweets = tc.search(username="elonmusk", until="2015")
        
            >>> # add limit and interval
            >>> tweets = tc.search(username="elonmusk", until="2015", limit=100, interval=1)
        
            >>> # search tweets contains `love` word
            >>> tweets = tc.search(query="love", limit=100, interval=1)
        
            >>> # search tweets which contains `love` word and were tweeted since 2015-01-01
            >>> tweets = tc.search(query="love", since="2015-01-01", limit=10)
        
        
        .. csv-table:: Supported methods
            :header: "method", "description"
            :widths: 20, 40
        
            "get_followers()", "get user followers"
            "get_friends()", "get user followings/friends"
            "get_timeline()", "get user timeline/tweets"
            "get_user()", "get user profile info"
            "search()", "search tweets with query and username"
        
        
        Meta
        ----
        Fardin Allahverdinazhand - `@0x0ptim0us <https://twitter.com/0x0ptim0us>`_  - 0x0ptim0us@gmail.com
        Distributed under the MIT license. see `LICENSE.txt <https://github.com/0x0ptim0us/twpy/blob/master/LICENSE.txt>`_ for more information.
        
        https://github.com/0x0ptim0us/twpy
Keywords: python3,twitter,twitter api,twpy,twitter scraper
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Natural Language :: English
