A Python SDK for interacting with the GavaConnect API, providing a simple and intuitive interface for developers.
- π Simple and intuitive API interface
- π Secure authentication handling
- π¦ Lightweight with minimal dependencies
- π§ͺ Comprehensive test coverage
- π Type hints for better development experience
- π Python 3.13+ support
pip install gavaconnect-sdk-pythonuv add gavaconnect-sdk-pythongit clone https://github.com/acoruss/gavaconnect-sdk-python.git
cd gavaconnect-sdk-python
uv installfrom gavaconnect import main
# Basic usage example
main()- Python 3.13+
- uv (recommended) or pip
-
Clone the repository:
git clone https://github.com/acoruss/gavaconnect-sdk-python.git cd gavaconnect-sdk-python -
Install dependencies:
uv sync --extra dev
-
Activate the virtual environment:
source .venv/bin/activate
# Run all tests
uv run pytest
# Run tests with coverage
uv run pytest --cov=gavaconnect
# Run tests with coverage report
uv run pytest --cov=gavaconnect --cov-report=htmlThis project uses several tools to maintain code quality:
- Ruff: Fast linting and formatting
- mypy: Static type checking
- bandit: Security linting
- pytest: Testing framework
# Lint code
uv run ruff check
# Format code
uv run ruff format
# Type checking
uv run mypy gavaconnect
# Security checking
uv run bandit -r gavaconnect# Using uv
uv run gavaconnect-sdk-python
# Or if installed globally
gavaconnect-sdk-pythonFor detailed documentation, please visit our GitHub repository.
We welcome contributions! Please see our contributing guidelines for details.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests and ensure they pass
- Run code quality checks
- Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
See CHANGELOG.md for a detailed history of changes.
This project is licensed under the MIT License - see the LICENSE file for details.
- π« Email: [email protected]
- π Issue Tracker
- π¬ Discussions
- Acoruss - Initial work - acoruss
- Musale Martin - Maintainer - [email protected]
Made with β€οΈ by the Acoruss team