Development • Support • Contribute • Contributors • Licensing
The goal of this project is to help build voice applications and integrate voice into other applications.
The Magenta Voice Skill SDK for Python is a package that assists in creating skill implementations for the Voice Applications built using the Magenta Voice Platform.
The overview documentation for the Telekom Voicification Suite can be found here.
The full documentation on how to use this software development kit is available here.
- The installation guide for technical details.
- Have a look at the Contribution Guide
- End-to-end documentation on how to build skills
- Working with Demo Skill
- Creating a Custom Weather Skill
Requires Python 3.7! Type hints FTW!
Remark
This repository uses the *_test.py naming schema. PyCharm discovers everything automatically. But if you like to invoke unit tests from the command line, and you are not sure about how, please check scripts/test.
Make sure to have an actual version of Python 3 (3.7 is minimum required)
and pip installed. Use
apt-get install python3-pip if you don't on Ubuntu or brew install python3 on MacOS.
Note: Some distros might require
python3-venvpackage installed. Runapt-get install python3-venvif you encounter difficulties when creating virtual environments for new projects.
- Clone the repo:
https://github.com/telekom/voice-skill-sdk.git - Change to SDK dir:
cd voice-skill-sdk - Run new-skill install:
python setup.py new_skill
Alternatively, a one-liner for @4thel00z
pip download --no-deps --no-binary :all: skill-sdk && tar xzf skill-sdk-*.tar.gz && python skill-sdk-*/setup.py new_skill
You'll be prompted for:
- The skill name. Give it an Awesome Name!
- Programming language. Python is Awesome!
- The directory where the project will be created. Make sure it's writable.
This script will:
- Create a new project in the directory of your choice.
- Add a virtual environment to
.venvinside your project. - Install required dependencies.
You may now open your skill directory as a project in PyCharm.
If you get an error
This package requires Python version >= 3.7 and Python's setuptools, you happen to have an outdated Python version. Check it withpython --versionand make sure it is >= 3.7
Happy coding!
This project has adopted the Contributor Covenant in version 2.0 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.
We decided to apply English as the primary project language.
Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
|---|---|
| Issues |  |
| Other Requests |  |
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.
Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.
Copyright (c) 2020 Deutsche Telekom AG.
Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License by reviewing the file LICENSE in the repository.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.