Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (67 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

120 lines (67 loc) · 1.83 KB
Raw

Contributing

Contributions are welcome. This is a generated library, and changes to core files should be promoted to our generator code.

Prerequisites

  • Python 3.10+
  • Docker Desktop

Some integration tests use WireMock containers. Ensure Docker Desktop is installed and running before executing the test suite.

Fork Repository

Fork this repo on GitHub.

Clone Repository

git clone https://github.com/YOUR_USERNAME/deepgram-python-sdk.git
cd deepgram-python-sdk

Install Poetry

curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1

Ensure Poetry is in your $PATH.

Note for Windows users: If poetry --version is not recognized, add Poetry's Scripts directory to your PATH and restart the terminal.

Typical Windows location:

C:\Users\<username>\AppData\Roaming\Python\Scripts

Verify Installation

poetry --version
docker ps

If Docker is running correctly, docker ps should return a container listing (which may be empty).

Install Dependencies

poetry install

Run Tests

poetry run pytest -rP .

Install Example Dependencies

poetry run pip install -r examples/requirements.txt

Configure Deepgram API Key

Create an API key in the Deepgram Console.

Windows

set DEEPGRAM_API_KEY=YOUR_API_KEY

Linux/macOS

export DEEPGRAM_API_KEY=YOUR_API_KEY

Run Example

poetry run python -u examples/listen/v1/media/transcribe_url/with_additional_query_parameters.py

A successful run will display a transcription response from the Deepgram API.

Commit Changes

git add .
git commit -m "feat: your change description"

Push to Fork

git push origin main

Create Pull Request

Open a pull request from your fork to the main repository.