Metadata-Version: 1.1
Name: zwift-client
Version: 0.2.0
Summary: Zwift Mobile API client.
Home-page: https://github.com/jsmits/zwift-client
Author: Sander Smits
Author-email: jhmsmits@gmail.com
License: MIT license
Description-Content-Type: UNKNOWN
Description: =======================
        Zwift Mobile API client
        =======================
        
        
        .. image:: https://img.shields.io/pypi/v/zwift-client.svg
                :target: https://pypi.python.org/pypi/zwift-client
        
        .. image:: https://img.shields.io/travis/jsmits/zwift-client.svg
                :target: https://travis-ci.org/jsmits/zwift-client
        
        .. image:: https://pyup.io/repos/github/jsmits/zwift-client/shield.svg
             :target: https://pyup.io/repos/github/jsmits/zwift-client/
             :alt: Updates
        
        
        Zwift Mobile API client written in Python. Heavily inspired by zwift-mobile-api_.
        
        
        Installation
        ------------
        
        ::
        
            $ pip install zwift-client
        
        
        Usage
        -----
        
        
        Client
        ++++++
        
        ::
        
            >>> from zwift import Client
            >>> username = 'your-username'
            >>> password = 'your-password'
            >>> player_id = your-player-id
            >>> client = Client(username, password)
        
        
        Profile
        +++++++
        
        ::
        
            >>> profile = client.get_profile()
            >>> profile.profile  # fetch your profile data
            >>> profile.followers
            >>> profile.followees
            >>> profile.get_activities()  # metadata of your activities
            >>> profile.latest_activity  # metadata of your latest activity
        
        
        Activity
        ++++++++
        
        ::
        
            >>> activity = client.get_activity(player_id)
            >>> activities = activity.list()  # your activities (default start is 0, default limit is 20)
            >>> activities = activity.list(start=20, limit=50)
            >>> latest_activity_id = activities[0]['id']
            >>> activity.get_activity(latest_activity_id)  # metadata of your latest activity
            >>> activity.get_data(latest_activity_id)  # processed FIT file data
        
        
        World
        +++++
        
        ::
        
            >>> world = client.get_world(1)  # get world with id 1
            >>> world.players  # players currently present in this world
            >>> world.player_status(player_id) # current player status information like speed, cadence, power, etc.
        
        
        Credits
        ---------
        
        This package was created with cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _zwift-mobile-api: https://github.com/Ogadai/zwift-mobile-api
        
        
        
        =======
        History
        =======
        
        
        0.2.0 (2018-03-02)
        ------------------
        
        - Add optional ``start`` and ``limit`` keyword arguments to ``Activity.list()``.
        
        
        0.1.0 (2018-01-14)
        ------------------
        
        * Initial release.
        
Keywords: zwift
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
