Skip to main content

The NANO (v2) part of the xbox smartglass library

Project description

Xbox-Smartglass-Nano

PyPi version Docs Build status Discord chat

The gamestreaming part of the smartglass library, codename NANO.

Currently supported version:

  • NANO v1 (Xbox One family)

XCloud and new XHome streaming are Nano v3, required for Xbox Series S/X.

For in-depth information, check out the documentation: (https://openxbox.github.io)

Features

  • Stream from your local Xbox One (OG/S/X) console

Dependencies

Install

pip install xbox-smartglass-nano

How to use

xbox-nano-client

Known issues

  • Video / Audio / Input is not smooth yet
  • ChatAudio and Input Feedback not implemented

Development workflow

Ready to contribute? Here's how to set up xbox-smartglass-nano-python for local development.

  1. Fork the xbox-smartglass-nano-python repo on GitHub.
  2. Clone your fork locally
git clone git@github.com:your_name_here/xbox-smartglass-nano-python.git
  1. Install your local copy into a virtual environment. This is how you set up your fork for local development
python -m venv ~/pyvenv/xbox-smartglass
source ~/pyvenv/xbox-smartglass/bin/activate
cd xbox-smartglass-nano-python
pip install -e .[dev]
  1. Create a branch for local development::
git checkout -b name-of-your-bugfix-or-feature
  1. Make your changes.

  2. Before pushing the changes to git, please verify they actually work

pytest
  1. Commit your changes and push your branch to GitHub::
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. Code includes unit-tests.
  2. Added code is properly named and documented.
  3. On major changes the README is updated.
  4. Run tests / linting locally before pushing to remote.

Credits

This package uses parts of Cookiecutter and the audreyr/cookiecutter-pypackage project template

CHANGELOG

0.10.0 (2020-12-12)

  • Change of license -> MIT license
  • Deprecated Python 3.6, Added Python 3.9
  • Migration from gevent to asyncio (in sync with smartglass-core)
  • Migration from marshmallow objects to pydantic
  • Fixed controller and closing issues (#15)

0.9.4 (2020-02-29)

  • Fix KeyError for debug prints
  • PyAV 0.4.1 -> 6.1.0 compatibility

0.9.3 (2018-11-14)

  • Python 3.7 compatibility

0.9.2 (2018-09-30)

  • Fix TravisCI dependency on ffmpeg

0.9.1 (2018-09-29)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xbox-smartglass-nano-0.10.1.tar.gz (58.0 kB view hashes)

Uploaded source

Built Distribution

xbox_smartglass_nano-0.10.1-py2.py3-none-any.whl (50.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page