The aim of this project is …
We’re solving … problem but you may also use this project to …
The development language is English. All comments and documentation should be written in English so we can share our learnings with developers around the world.
We started this project on … for this particular use-case.
We open-sourced it on … / since the beginning because …
This project uses python 3.5 and rely mostly on Google speech libraries and
Portaudio. Before proceeding to any installation of project, ensure that you have
portaudio installed (most of the distribution will require portaudio-devel
package.
In order to proceed to the installation, please clone the repository found on github. Once installed, you have to run these commands to setup the project::
pyvenv venv source venv/bin/activate pip install --editable .
To play with it you can refer to the documentation available.:
transcribe --help
Be careful, in order to have the system working, it is necessary to specify
the credential file path using the argument --credentials.:
transcribe --credentials ~/credentials.json
Nothing at the moment.
- Here the help::
Usage: transcribe [OPTIONS]
Transcribe: Automatic and "almost" real time audio transcription.
- Options:
-c, --credentials-file TEXT Path to the credentials file. [default=credentials.json] -l, --language TEXT Language code used for transcription. [default=en-US] -s, --sample-rate INTEGER Sample rate in hertz of the stream. [default=16000] --channel-number INTEGER Number of channels used for the stream. [default=1] --timeout INTEGER Request timeout in milliseconds. [default=28000] --auth TEXT URL for the authentification. - --encoding [LINEAR16|FLAC|MULAW|AMR|AMR_WB]
- Audio stream encoding method. [default=LINEAR16]
-V, --version Version of this application -h, --help Show this message and exit.
We’re really happy to accept contributions from the community, that’s the main reason why we open-sourced it! There are many ways to contribute, even if you’re not a technical person.
We’re using the infamous simplified Github workflow to accept modifications (even internally), basically you’ll have to:
- create an issue related to the problem you want to fix (good for traceability
and cross-reference) * fork the repository * create a branch (optionally with the reference to the issue in the name) * hack hack hack * commit incrementally with readable and detailed commit messages * submit a pull-request against the master branch of this repository
We’ll take care of tagging your issue with the appropriated labels and answer within a week (hopefully less!) to the problem you encounter.
If you’re not familiar with open-source workflows or our set of technologies, do not hesitate to ask for help! We can mentor you or propose good first bugs (as labeled in our issues). Also welcome to add your name to Credits section of this document.
You can report issues directly on Github, that would be a really useful contribution given that we lack some user testing on the project. Please document as much as possible the steps to reproduce your problem (even better with screenshots).
We’re trying to develop this project in the open as much as possible. We have a dedicated mailing-list where we discuss each new strategic change and invite the community to give a valuable feedback. You’re encouraged to subscribe to it and participate.
We’re doing our best to document each usage of the project but you can improve it or add you own sections. The documentation is available within the /docs/ folder. You don’t have to build anything, we’ll take care of it once your changes are merged.
This project relies on the PEP8 coding style.
Version numbering follows the Semantic versioning approach.
We’re using the … license because we believe in …