From f3001d6496f6c62d6b740af8b97bb2f0da45840b Mon Sep 17 00:00:00 2001 From: Jackson Vieira Date: Wed, 3 Dec 2025 14:07:14 -0300 Subject: [PATCH] docs: add development workflow documentation --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6810a2f..934f03c 100644 --- a/README.md +++ b/README.md @@ -1242,4 +1242,60 @@ The WebSocket Manager has robust error handling: 3. Use logging for debugging and monitoring 4. Consider implementing a heartbeat mechanism if needed 5. Keep your API token secure and don't expose it in logs -6. Keep your API token secure and don't expose it in logs + +## Contributing + +This project uses Python >= 3.8 and uv: + +### Setup Development Environment + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh + +git clone https://github.com/EvolutionAPI/evolution-client-python.git +cd evolution-client-python + +uv sync +``` + +### Code Quality + +This project uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting: + +```bash +# Format code +uv run ruff format + +# Check linting +uv run ruff check + +# Fix auto-fixable issues +uv run ruff check --fix +``` + +### Building and Publishing + +```bash +# Build the package +uv build + +# Publish to PyPI (requires credentials) +uv publish + +# Or use the provided script +./publish.sh +``` + +### Adding Dependencies + +```bash +# Add a runtime dependency +uv add package-name + +# Add a development dependency +uv add --dev package-name +``` + +## License + +MIT