paystack-django 1.0.0__tar.gz

paystack_django-1.0.0/CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-02-13
+
+### Added
+
+- ✨ Complete Paystack API integration with all endpoints
+- ✨ Django models for transactions, customers, plans, products, and more
+- ✨ Webhook support with automatic verification and signal dispatch
+- ✨ Comprehensive configuration system with environment variable support
+- ✨ Signal support for payment events (success, failed, verified, etc.)
+- ✨ Type hints throughout the codebase for better IDE support
+- ✨ Extensive error handling with custom exception classes
+- ✨ Automatic retry mechanism with exponential backoff
+- ✨ Request/response logging for debugging
+- ✨ Pagination support for list endpoints
+- ✨ Caching support for frequently accessed data
+- ✨ Async-ready design for future async support
+- ✨ Comprehensive test suite with high coverage
+- ✨ Full API documentation with examples
+- ✨ Support for Django 3.2 through Django 5.0
+- ✨ Support for Python 3.8 through Python 3.12
+
+### Supported Services
+
+- Transactions - Create, verify, and manage transactions
+- Customers - Create and manage customer records
+- Plans - Create and manage subscription plans
+- Subscriptions - Manage customer subscriptions
+- Transfers - Handle fund transfers to bank accounts
+- Refunds - Process and manage refunds
+- Disputes - Manage transaction disputes
+- Settlements - Track settlement information
+- Splits - Configure payment splits between accounts
+- Subaccounts - Manage subaccounts
+- Products - Create and manage products
+- Payment Requests - Generate payment request links
+- Verification - Bank and account verification
+- Direct Debit - Direct debit authorization
+- Terminal - Terminal operations
+- Apple Pay - Apple Pay integration
+- Virtual Terminal - Virtual terminal operations
+- Pages - Create and manage pages
+- Bulk Charges - Batch charge operations
+- Integration - Integration-related operations
+- Miscellaneous - Other utility endpoints
+
+### Features
+
+- 🔐 Secure webhook signature verification
+- 🔄 Automatic transaction verification
+- 📊 Comprehensive transaction tracking
+- 🏪 Multi-merchant support via subaccounts
+- 💳 Multiple payment methods support
+- 📱 Apple Pay integration
+- 💰 Payment splits and routing
+- 🔗 Linked bank accounts for payouts
+- 📧 Email-based customer identification
+- 🏦 Bank account verification
+- 📱 Phone number verification
+- 🗂️ Flexible metadata storage
+- 🔍 Advanced filtering and pagination
+- 📝 Comprehensive logging
+
+### Documentation
+
+- 📚 Full API documentation
+- 🎓 Quick start guide
+- 📖 Configuration guide
+- 🔧 Integration examples
+- 🧪 Testing guide
+- 🔐 Security best practices
+
+---
+
+---
+
+## Support
+
+For issues or feature requests, please visit [GitHub Issues](https://github.com/HummingByteDev/paystack-django/issues).
+
+---
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

paystack_django-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,275 @@
+# Contributing to paystack-django
+
+Thank you for your interest in contributing to paystack-django! We welcome contributions from anyone and are grateful for even the smallest of fixes!
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, search the issue list to see if the problem has already been reported. If you find your bug is not listed, create a new issue with:
+
+- **Use a clear and descriptive title**
+- **Describe the exact steps which reproduce the problem** in as many details as possible
+- **Provide specific examples** to demonstrate the steps
+- **Describe the behavior you observed** after following the steps
+- **Explain which behavior you expected to see** instead and why
+- **Include screenshots and animated GIFs** if possible
+- **Include your environment details**:
+  - Python version
+  - Django version
+  - paystack-django version
+  - Operating System
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, provide:
+
+- **Use a clear and descriptive title**
+- **Provide a step-by-step description** of the suggested enhancement
+- **Provide specific examples** to demonstrate the steps
+- **Describe the current behavior** and **the expected behavior**
+- **Explain why this enhancement would be useful**
+
+### Pull Requests
+
+Pull requests are the best way to propose changes. We actively welcome them.
+
+- Fill in the provided pull request template
+- Follow the Python/Django styleguides
+- Document new code with docstrings
+- End all files with a newline
+- Avoid platform-dependent code
+- Add tests for any new functionality
+
+## Development Setup
+
+### 1. Fork and Clone the Repository
+
+```bash
+git clone https://github.com/YOUR-USERNAME/django-paystack.git
+cd django-paystack
+```
+
+### 2. Create a Virtual Environment
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+### 3. Install Development Dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+### 4. Create a New Branch
+
+```bash
+git checkout -b feature/your-feature-name
+# or
+git checkout -b fix/your-bug-fix
+```
+
+## Development Workflow
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=djpaystack --cov-report=html
+
+# Run specific test file
+pytest djpaystack/tests/test_client.py
+
+# Run specific test
+pytest djpaystack/tests/test_client.py::TestPaystackClient::test_initialization
+```
+
+### Running Tests Across Python Versions
+
+```bash
+tox
+```
+
+### Code Style
+
+We use several tools to maintain code quality:
+
+```bash
+# Format code with black
+black djpaystack
+
+# Sort imports with isort
+isort djpaystack
+
+# Check for style issues
+flake8 djpaystack
+
+# Run type checks
+mypy djpaystack
+```
+
+### Automated Code Quality
+
+Before submitting a pull request, run all checks:
+
+```bash
+# Format and check
+black djpaystack
+isort djpaystack
+flake8 djpaystack
+mypy djpaystack --ignore-missing-imports
+pytest --cov=djpaystack
+```
+
+## Styleguides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+- Consider starting the commit message with an applicable emoji:
+  - 🎨 `:art:` when improving the format/structure of the code
+  - 🐛 `:bug:` when fixing a bug
+  - ✅ `:white_check_mark:` when adding tests
+  - 📚 `:books:` when writing docs
+  - 🎉 `:tada:` when releasing a new version
+  - ⚡ `:zap:` when improving performance
+  - 🔒 `:lock:` when dealing with security
+  - ⬆️ `:arrow_up:` when upgrading dependencies
+
+Example:
+
+```
+🎨 Reformat payment response handling
+
+- Improved clarity of response parsing
+- Added inline documentation
+- Fixes #123
+```
+
+### Python Styleguide
+
+We follow PEP 8 with the following additions:
+
+- Use type hints for function parameters and return values
+- Maximum line length is 100 characters (not 79)
+- Use docstrings for all public modules, functions, classes, and methods
+- Use Google-style docstrings
+
+Example:
+
+```python
+def initialize_transaction(
+    email: str,
+    amount: int,
+    reference: str,
+    **kwargs
+) -> Dict[str, Any]:
+    """
+    Initialize a new transaction on Paystack.
+
+    Args:
+        email: Customer email address
+        amount: Amount in kobo (e.g., 50000 = 500 NGN)
+        reference: Unique transaction reference
+
+    Returns:
+        API response containing authorization URL and access code
+
+    Raises:
+        PaystackValidationError: If validation fails
+        PaystackAPIError: If API returns an error
+    """
+```
+
+### Documentation Styleguide
+
+- Use Markdown for documentation
+- Use clear, concise language
+- Include code examples where helpful
+- Update relevant documentation when making changes
+
+## Pull Request Process
+
+1. **Create a fork** of the repository
+2. **Create a feature branch** from `main`
+3. **Make your changes** with clear, descriptive commits
+4. **Add tests** for new functionality
+5. **Update documentation** as needed
+6. **Run tests** and ensure they pass
+7. **Push to your fork** and create a Pull Request
+8. **Write a clear PR description** explaining your changes
+9. **Link any related issues** using keywords like `Closes #123`
+
+## What to Include in a Pull Request
+
+- **Clear description** of the changes made
+- **Link to related issues** (if applicable)
+- **Testing information**: What tests did you run? How did you verify?
+- **Screenshots or examples** (if visual changes)
+- **Backward compatibility** notes (if applicable)
+- **Performance impact** (if applicable)
+
+## Review Process
+
+- At least one maintainer review is required before merging
+- Automated tests must pass
+- Code quality checks must pass
+- Documentation must be updated
+
+## Release Process
+
+1. Update `__version__` in `djpaystack/__init__.py`
+2. Update `pyproject.toml` version
+3. Update `CHANGELOG.md` with release notes
+4. Create a new Git tag: `git tag v1.x.x`
+5. Push to repository
+6. Build and upload to PyPI:
+   ```bash
+   python -m build
+   python -m twine upload dist/*
+   ```
+
+## Dependencies
+
+When adding new dependencies:
+
+1. Consider the impact on package size and installation time
+2. Use well-maintained, popular packages
+3. Add to appropriate section in `pyproject.toml`
+4. Update documentation with new dependency information
+5. Explain why the dependency is needed in the PR
+
+## Questions?
+
+Feel free to ask questions by:
+
+- Opening an issue with the `question` label
+- Starting a discussion on GitHub Discussions
+- Emailing the maintainers
+
+## Additional Notes
+
+- This is a volunteer-driven project
+- We appreciate your patience as maintainers may need time to review
+- Be respectful to other contributors
+- Help others when you can
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+---
+
+**Thank you for contributing to paystack-django!** 🎉

paystack_django-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Humming Byte
+
+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.

paystack_django-1.0.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CONTRIBUTING.md
+recursive-include djpaystack *.py
+recursive-include djpaystack *.html
+recursive-include djpaystack *.txt
+recursive-include djpaystack *.yml
+recursive-include djpaystack *.yaml
+recursive-include djpaystack *.json
+exclude djpaystack/__pycache__
+exclude djpaystack/*/__pycache__
+exclude djpaystack/*/*/__pycache__
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]
+recursive-exclude * *.so