Welcome to django-flexible-payments’s documentation!¶
Contents:
django-flexible-payments¶
Independent and reusable Payment app for Django, used to build the Django Subscription Plan System.
Why¶
Taking inspiration from silver django-payments django-getpaid django-plans django-invoices django-flexible-payments offers a customizable approach to support payments; PaymentMethod and Transaction are connected with their PaymentProcessor
How¶
Documentation¶
The full documentation is at https://django-flexible-payments.readthedocs.io.
Quickstart¶
Install django-flexible-payments:
pip install django-flexible-payments
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'flexible_payments.apps.FlexiblePaymentsConfig',
...
)
Add django-flexible-payments’s URL patterns:
from flexible_payments import urls as flexible_payments_urls
urlpatterns = [
...
url(r'^payments/', include(flexible_payments_urls)),
...
]
Features¶
- TODO
Running Tests¶
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits¶
Tools used in rendering this package:
Installation¶
At the command line:
$ easy_install django-flexible-payments
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv django-flexible-payments
$ pip install django-flexible-payments
Usage¶
To use django-flexible-payments in a project, add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'flexible_payments.apps.FlexiblePaymentsConfig',
...
)
Add django-flexible-payments’s URL patterns:
from flexible_payments import urls as flexible_payments_urls
urlpatterns = [
...
url(r'^', include(flexible_payments_urls)),
...
]
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/ninjabit/django-flexible-payments/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
django-flexible-payments could always use more documentation, whether as part of the official django-flexible-payments docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/ninjabit/django-flexible-payments/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up django-flexible-payments for local development.
Fork the django-flexible-payments repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-flexible-payments.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv django-flexible-payments $ cd django-flexible-payments/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 flexible_payments tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/ninjabit/django-flexible-payments/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Tobia Ghiraldini <tobia.ghiraldini@ninjabit.com>
Contributors¶
None yet. Why not be the first?