/RokuPi

A pip package for helping with Roku development.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

RokuPi

A pip package for helping with Roku development.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

A step by step series of examples that tell you how to get a development env running

Clone Repo

git clone https://github.com/CCecilia/RokuPi.git

Create Virtualenv

python3 -m venv {path/to/rokuPi}

Make rokuPi your current working directory

cd {path/to/rokuPi}

Activate Virtual environment, you should see (rokuPi) after

source bin/activate

Install dependencies

pip install -r requirements.txt

Install rokuPi as pip module

pip install --editable .

Running the tests

python3 -m unittest

And coding style tests

All coding styles should strictly follow PEP8 guidelines.

Built With

  • Click - The cli framework used

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Christian Cecilia - Initial work - GH

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details