Metadata-Version: 2.1
Name: pybyte
Version: 0.1.3
Summary: Byte API Wrapper for Python
Home-page: https://github.com/ms7m/py-byte
Author: Mustafa Mohamed
Author-email: mustafa@ms7m.me
License: MIT
Description: 
        ![pybyte-logo](images/logo.svg)
        
        *** 
        
        # Byte API Wrapper for Python
        Python 3.6+ Required.
        ***
        **Attention**: This project was built in a weekend (mostly in the weekend that it was launched) as such this is **not production level** software. 
        
        Byte **does not** have an official web API for developers, and most likely this will violate the ToS. Endpoints were found from the mobile app. As such, this wrapper can break at anytime. Do not rely on this wrapper.
        ***
        
        
        # Installation
        - PyPi (Recommended)
            ```
            pip install pybyte
            ```
        - Git repo
            ```
            git clone https://github.com/ms7m/py-byte
            cd py-byte
            python3 setup.py install
            ```
        
        # Features
        - View Byte Profile ``ByteUser, ByteAccount``
        - View Byte Posts: ``BytePost``
        - Send authenticated requests to Byte API ``ByteSession``
        - Upload Bytes
        - Follow Users
        - Rebyte Posts
        - Comment on Posts
        - Like Posts
        
        
        # To Do
        - Update user information 
        - Change Username
        - Show feed
        ~
        
        # Usage
        
        
        > View your account
        
        ```python
        >> import pybyte
        
        >> byte = pybyte.Byte(<google auth token>)
        >>> me = byte.me()
        >>> me
        <pybyte.user.ByteAccount object at 0x1069a2150>
        
        ...
        
        >>> me.user().user_id
        'MZBW6JBYUBDKBMQK62LCBS7I6Q'
        >>> me.user().username
        'gjoder'
        >>> me.user().registered
        datetime.datetime(2020, 1, 26, 4, 40, 57, tzinfo=tzutc())
        >>> 
        
        
        ```
        
        > View a post
        
        ```python
        >>> import pybyte
        >>> 
        >>> byte = pybyte.Byte()
        2020-01-26 12:28:12.623 | INFO     | pybyte.byte:__init__:87 - loaded from cache.
        >>> post = byte.get_post("4ZPUKLE5OZB7JJGIBLVMIYQLBU")
        
        >>> post.caption
        '@peaks '
        
        >>> post.date
        datetime.datetime(2020, 1, 26, 15, 35, 32, tzinfo=tzutc())
        
        >>> post.mentions
        [<pybyte.user.ByteUser object at 0x104d03c90>]
        >>> 
        ```
        
        > Upload a video
        
        ```python
        >>> import pybyte
        >>>
        >>> byte = pybyte.Byte()
        2020-01-26 12:28:12.623 | INFO     | pybyte.byte:__init__:87 - loaded from cache.
        
        >> byte.upload("sample.mp4", caption="Hello from pybyte!")
        True
        ```
        
        **Attention**: You'll only need to supply a google OAuth (Soon to be done automatically) *once* and pybyte will cache the authorization token for you. After doing this one time, simply call ``pybyte.Byte`` without any arugments.
        
        # Tests
        Coming soon
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
