Contributing
We welcome contributions to psqlc!
Development Setup
Fork the repository:
git clone https://github.com/cumulus13/psqlc.git cd psqlc
Create virtual environment:
python -m venv venv source venv/bin/activate # Linux/macOS # or venv\\Scripts\\activate # Windows
Install development dependencies:
pip install -e ".[dev]"
Running Tests
pytest tests/
pytest --cov=psqlc tests/
Code Style
We use Black for code formatting:
black psqlc.py
flake8 psqlc.py
Building Documentation
cd docs
make html
# View at docs/_build/html/index.html
Pull Requests
Create a feature branch:
git checkout -b feature/your-feature
Make your changes
Add tests if applicable
Ensure all tests pass
Submit pull request
Guidelines
Follow PEP 8 style guide
Add docstrings to new functions
Update documentation for new features
Include examples in documentation
Write clear commit messages
Bug Reports
Submit bug reports at: https://github.com/cumulus13/psqlc/issues
Include:
Operating system and version
Python version
PostgreSQL version
Steps to reproduce
Expected vs actual behavior
Error messages
Feature Requests
We’re open to new features! Please open an issue to discuss before implementing.
License
By contributing, you agree that your contributions will be licensed under the MIT License. ```
MIT License
Copyright (c) 2025 Hadi Cahyadi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.