Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (42 loc) · 994 Bytes

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 994 Bytes

Contributing

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

Requires Python 3.8+

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.

Install Dependencies

poetry install

Run Tests

poetry run pytest -rP .

Install Example Dependencies

poetry run pip install -r examples/requirements.txt

Run Example

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

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.