This Python application is a template for Skill Developers to use as a starting point for writing an NLP Adapter Skill.
Written in FastAPI.
See the Soul Machines Skills Documentation for more information.
Create the .env file and add env variables as needed.
cp .env_example .env
You may run the following commands to quickly spin up the application.
docker-compose up --build
When you want to stop the application, run:
docker-compose down
Create and activate Python's virtual env, then install requirements
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
Run the following to start your local development server
python manage.py run
- Set up virtual env and install requirements as per Local Development
- Click on Run and Debug
- Select Python: Local Debugging as the configuration
- Add your breakpoints
- Click the Play button
Test the app's endpoints using Postman:
- POST Init: http://localhost:3000/init
- POST Session: http://localhost:3000/session
- POST Execute: http://localhost:3000/execute
- DELETE Delete: http://localhost:3000/delete
- Auto-generated OpenAPI docs of your app: http://localhost:3000/docs
Localtunnel may be used to generate a public web address for your locally-running Skill, allowing DDNA Studio to connect to your Skill from a live Digital Person.
Generate a URL with a personalized subdomain using the following command, and then use this URL to configure the endpoints in your Skill Definition.
npx localtunnel --port 3000 --subdomain your-unique-id
This repository is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
For any issues, please reach out to one of our Customer Success team members.