Metadata-Version: 2.0
Name: xbox-webapi
Version: 1.0.8
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
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
Requires-Dist: requests
Requires-Dist: python-dateutil
Requires-Dist: demjson
Provides-Extra: dev
Requires-Dist: pip (==9.0.1); extra == 'dev'
Requires-Dist: bumpversion (==0.5.3); extra == 'dev'
Requires-Dist: wheel (==0.30.0); extra == 'dev'
Requires-Dist: watchdog (==0.8.3); extra == 'dev'
Requires-Dist: flake8 (==3.5.0); extra == 'dev'
Requires-Dist: tox (==2.9.1); extra == 'dev'
Requires-Dist: coverage (==4.5.1); extra == 'dev'
Requires-Dist: Sphinx (==1.7.1); extra == 'dev'
Requires-Dist: twine (==1.10.0); extra == 'dev'
Requires-Dist: betamax (==0.8.1); extra == 'dev'
Requires-Dist: pytest (==3.4.2); extra == 'dev'
Requires-Dist: pytest-runner (==2.11.1); extra == 'dev'

===========
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 is also possible.

Dependencies
------------
* Python >= 3.5
* Libraries: requests, python-dateutil, demjson

How to use
----------
Install::

  pip install xbox-webapi

Authentication::

  xbox-authenticate --tokenfile tokens.json --email no@live.com --password abc123

  # If no credentials are provided via cmdline, they are requested from stdin
  xbox-authenticate --tokenfile tokens.json
  >> Input authentication credentials
  >> Email: <input>
  >> Password: <input>

API usage::

  # Search Xbox One Catalog
  xbox-searchlive --tokenfile tokens.json "Some game title"

  # Search Xbox 360 Catalog
  xbox-searchlive --tokenfile 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.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.


