Metadata-Version: 2.1
Name: xbox-webapi
Version: 1.1.2
Summary: A library to authenticate with Windows Live/Xbox Live and use their API
Home-page: https://github.com/OpenXbox/xbox-webapi-python
Author: OpenXbox
License: GPL
Description: ===========
        Xbox-WebAPI
        ===========
        
        .. image:: https://pypip.in/version/xbox-webapi/badge.svg
            :target: https://pypi.python.org/pypi/xbox-webapi/
            :alt: Latest Version
        
        .. image:: https://readthedocs.org/projects/xbox-webapi-python/badge/?version=latest
            :target: http://xbox-webapi-python.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://travis-ci.org/OpenXbox/xbox-webapi-python.svg?branch=master
            :target: https://travis-ci.org/OpenXbox/xbox-webapi-python
        
        
        Xbox-WebAPI is a python library to authenticate with Xbox Live via your Microsoft Account and provides Xbox related Web-API.
        
        Authentication via credentials or tokens is supported, Two-Factor-Authentication ( 2FA ) is also possible.
        
        Dependencies
        ------------
        * Python >= 3.5
        * Libraries: requests, demjson, appdirs, urwid
        
        How to use
        ----------
        Install::
        
          pip install xbox-webapi
        
        Authentication::
        
          # Token save location: If tokenfile is not provided via cmdline, fallback
          # of <appdirs.user_data_dir>/tokens.json is used as save-location
          #
          # Specifically:
          # Windows: C:\\Users\\<username>\\AppData\\Local\\OpenXbox\\xbox
          # Mac OSX: /Users/<username>/Library/Application Support/xbox/tokens.json
          # Linux: /home/<username>/.local/share/xbox
          #
          # For more information, see: https://pypi.org/project/appdirs and module: xbox.webapi.scripts.constants
        
          xbox-authenticate --tokens tokens.json --email no@live.com --password abc123
        
          # NOTE: If no credentials are provided via cmdline, they are requested from stdin
          xbox-authenticate --tokens tokens.json
        
          # If you have a shell compatible with ncurses, you can use the Terminal UI app
          xbox-auth-ui --tokens tokens.json
        
        Fallback Authentication::
        
          # In case this authentication flow breaks or you do not trust the code with your credentials..
          # Open the following URL in your web-browser and authenticate
          https://login.live.com/oauth20_authorize.srf?display=touch&scope=service%3A%3Auser.auth.xboxlive.com%3A%3AMBI_SSL&redirect_uri=https%3A%2F%2Flogin.live.com%2Foauth20_desktop.srf&locale=en&response_type=token&client_id=0000000048093EE3
        
          # Once you finished auth and reached a blank page, copy the redirect url from your browser address-field
          # Execute the script with supplied redirect url
          xbox-auth-via-browser 'https://login.live.com/oauth20_desktop.srf?...access_token=...&refresh_token=...'
        
        API usage::
        
          # Search Xbox One Catalog
          xbox-searchlive --tokens tokens.json "Some game title"
        
          # Search Xbox 360 Catalog
          xbox-searchlive --tokens tokens.json -l "Some game title"
        
        Known issues
        ------------
        * There are a lot of missing XBL endpoints
        
        Contribute
        ----------
        * Report bugs/suggest features
        * Add/update docs
        * Add additional xbox live endpoints
        
        Credits
        -------
        This package uses parts of Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        The authentication code is based on `joealcorn/xbox`_
        
        Informations on endpoints gathered from:
        
        * `XboxLive REST Reference`_
        * `XboxLiveTraceAnalyzer APIMap`_
        * `Xbox Live Service API`_
        
        .. _`joealcorn/xbox`: https://github.com/joealcorn/xbox
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _`XboxLive REST Reference`: https://docs.microsoft.com/en-us/windows/uwp/xbox-live/xbox-live-rest/atoc-xboxlivews-reference
        .. _`XboxLiveTraceAnalyzer APIMap`: https://github.com/Microsoft/xbox-live-trace-analyzer/blob/master/Source/XboxLiveTraceAnalyzer.APIMap.csv
        .. _`Xbox Live Service API`: https://github.com/Microsoft/xbox-live-api
        
        Disclaimer
        ----------
        Xbox, Xbox One, Smartglass and Xbox Live are trademarks of Microsoft Corporation. Team OpenXbox is in no way endorsed by or affiliated with Microsoft Corporation, or any associated subsidiaries, logos or trademarks.
        
        
        =======
        History
        =======
        
        1.1.1 (2018-05-03)
        ------------------
        
        * Removed python-dateutil dependency
        * Add auth-via-browser fallback script
        * Small changes
        
        1.1.0 (2018-04-17)
        ------------------
        
        * Auth: Updated 2FA authentication to meet current windows live auth flow
        * Auth: Redesigned 2FA authentication procedure
        * Auth: Implemented xbox-auth-ui script (xbox.webapi.scripts.tui: urwid terminal ui)
        * Auth: For password masking, getpass instead or raw input() is used
        * Scripts: Default to appdirs.user_data_dir if no tokenfile provided via cmdline argument (see README)
        
        1.0.9 (2018-03-30)
        ------------------
        
        * Extend **Gameclips** provider with title id filtering and saved clips
        * Add **Screenshots** provider
        * Add **Titlehub** provider
        
        1.0.8 (2018-03-29)
        ------------------
        
        * Added **Userstats** endpoint
        * Updated README
        
        1.0.7 (2018-03-28)
        ------------------
        
        * Support supplying auth credentials via stdin
        * Added tests for all endpoints
        * Added tests for authentication
        * Added **QCS** endpoint
        * Added **Profile** endpoint
        * Added **Achievements** endpoint
        * Added **Usersearch** endpoint
        * Added **Gameclips** endpoint
        * Added **People** endpoint
        * Added **Presence** endpoint
        * Added **Message** endpoint
        * Removed **Gamerpics** endpoint
        
        1.0.3 - 1.0.6 (2018-03-17)
        --------------------------
        
        * Metadata changes
        
        1.0.2 (2018-03-17)
        ------------------
        
        * More metadata changes, rendering on PyPi is fine now
        
        1.0.1 (2018-03-17)
        ------------------
        
        * Metadata changes
        
        1.0.0 (2018-03-17)
        ------------------
        
        * First release on PyPI.
        
Keywords: xbox one live api
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: dev
