README¶

Echo VR API¶

Python bindings for Echo VR’s HTTP API.

Installation¶

If you haven’t already, install Python 3 and Pipenv.

Now, in your project directory, run:

pipenv install echovr-api

Usage¶

Basic usage example:

from requests.exceptions import ConnectionError
import json
import echovr_api

try:
    game_state = echovr_api.fetch_state()

    print(f"Game status: {game_state.game_status}")
    print(f"Seconds on clock: {game_state.game_clock}")

    if (game_state.blue_team.score > game_state.orange_team.score):
        print("Blue team is winning!")
    elif (game_state.orange_team.score > game_state.blue_team.score):
        print("Orange team is winning!")
    else:
        print("It's tied!")

    print(f"Score: {game_state.blue_team.score} - {game_state.orange_team.score}")

except ConnectionError as e:
    print("Connection refused. Make sure you're running Echo VR with the -http option and that you're in a match.")
except json.decoder.JSONDecodeError as e:
    print("Could not decode response. (Not valid JSON.)")

For comprehensive documentation of the available methods and classes, please see the full API Documentation on Read The Docs.

Contributing¶

To get everything you need to start making changes to this package, first install Python 3 and Pipenv, clone this repository, then run:

pipenv install --dev

Run the tests¶

To run all automated tests, run:

pipevn run pytest tests/

Try it¶

To play around with the API, open an instance of Echo VR with the -http flag, then run:

pipenv run python -i ./test.py

Generate documentation¶

To generate documentation for the project, run the following in the project root:

pipenv run sphinx-build docs/source/ docs/build/

You can then access the built documentation by opening the generated docs/build/index.html file in a web browser.

Release process¶

First, update CHANGELOG.md and the version number in setup.py and docs/source/conf.py. Then commit, tag, and push these changes.

Next, build the package:

pipenv install --dev
pipenv run python setup.py sdist bdist_wheel

Finally, upload the built packages to PyPi. You can do this using twine (pip install twine):

twine upload dist/*