README.md

Cleansio

Usage

python cleansio/cleansio.py --help

Requirements

1. Posix shell
2. Internet connection

Setup

1. Check the Requirements
2. Clone this repo
3. Install Python 3.5+
   • Anaconda is recommended
4. Download your Google Cloud Credentials JSON file
5. Set the following environment variables:

   export GOOGLE_APPLICATION_CREDENTIALS=<PATH_TO_JSON>

6. Follow these additional steps:
   • ffmpeg set-up
7. Install Cleansio's dependencies:

   pip install -r requirements.txt

8. Follow the real-time setup instructions
9. (OPTIONAL) If you're a developer run:

   pip install -r requirements-dev.txt

10. (OPTIONAL) Install the Google Cloud SDK
11. You're all set!

Documentation

Technical Documentation

Slideshow

Build Locally. Available at docs/_build/html/index.html

./bin/generate_docs

Linting

Run

./bin/lint

Help

pylint --help-msg=<ID>

Testing

./bin/test

Docker

Run

docker run \
  --tty \
  --rm \
  --volume <PATH_TO_MUSIC>:/music \
  --volume <PATH_TO_GOOGLE_CLOUD_SPEECH_JSON>:/google-cloud-speech-api.json \
  --name cleansio \
  patrickduncan/cleansio \
  /music/<MUSIC_FILE_NAME>

Build

docker build --tag "cleansio:dev" .

Contributors

Patrick D. Duncan 💻	Levin Noronha 💻	Corie Bain 💻	Victor Carri 💻