Transcribe API is a high-performance FastAPI backend application designed to provide a robust and scalable backend solution for AWS Transcription. It uses an OpenAPI spec and Swagger utilizing JSON Schema to ensure easy integration and high performance.
-
FastAPI Backend: Offers a high-performance backend solution that incorporates a modern, fast (high-performance) web framework for building APIs with Python 3.6+ based on standard Python type hints.
-
Swagger Compatibility: Supports Swagger, a powerful interface for REST APIs that allows both developers and non-developers to interact with the API’s resources. It provides insightful information about the operations, parameters, responses, and the direct testing of API endpoints within its UI.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You'll need to install the following items before you can use Transcribe API:
- Python 3.6 or later
- Poetry (Python dependency management)
- Docker (for containerization)
To install Poetry, you can use the following command:
curl -sSL https://install.python-poetry.org | python3 -After installing Poetry, make sure it's available in your PATH. You may need to add the following line to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc):
export PATH="$HOME/.local/bin:$PATH"Clone the repository:
git clone https://github.com/bastosmichael/transcribe-api.gitNavigate to the project directory:
cd transcribe-apiInstall the required dependencies using Poetry:
poetry installRun the application:
poetry run transcribeThe server should be running and the API can be accessed at localhost:8000.
The API documentation can be viewed at localhost:8000/docs when the server is running. The documentation is interactive, so you can test out API calls directly in your browser.
After installing the necessary dependencies, you can run the test suite using pytest. The command poetry run pytest runs pytest within the project's virtual environment:
poetry run pytestThis command will discover all test cases in your project (i.e., all files matching the pattern test_*.py or *_test.py in the current directory and subdirectories) and run them.
If you want to run a specific test file, you can specify it directly. For example, to only run the tests in test_main.py, you can use the following command:
poetry run pytest tests/test_main.pyFor more advanced usage, please refer to the pytest documentation.
We welcome contributions to Transcribe API! Please see our Contributing Guide for more details.
This project is licensed under the GNU General Public License v2.0 - see the LICENSE file for details.
If you have any questions, feel free to reach out to us at bastosmichael@gmail.com.
We would like to thank the creators and contributors of FastAPI, Swagger, and Poetry for their amazing tools that have helped make this project possible.