Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djaodjin/djaodjin-saas
Django application for software-as-service and subscription businesses
https://github.com/djaodjin/djaodjin-saas
django plans razorpay saas stripe subscriptions
Last synced: 2 days ago
JSON representation
Django application for software-as-service and subscription businesses
- Host: GitHub
- URL: https://github.com/djaodjin/djaodjin-saas
- Owner: djaodjin
- License: other
- Created: 2013-05-06T22:43:32.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T19:11:22.000Z (3 months ago)
- Last Synced: 2024-10-29T16:32:45.322Z (3 months ago)
- Topics: django, plans, razorpay, saas, stripe, subscriptions
- Language: Python
- Homepage:
- Size: 6.36 MB
- Stars: 565
- Watchers: 24
- Forks: 124
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: changelog
- License: LICENSE.txt
- Security: docs/security.rst
Awesome Lists containing this project
- starred-awesome - djaodjin-saas - Django application for subscription businesses (Python)
README
DjaoDjin-SaaS
=============
[](https://djaodjin-saas.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/djaodjin-saas)
djaodjin-saas is a Django application that implements the logic to support
subscription-based Software-as-a-Service businesses.
Major Features:
- Separate billing profiles and authenticated users
- Double entry book keeping ledger
- Flexible security framework
This project contains bare bone templates which are compatible with Django
and Jinja2 template engines. To see djaodjin-saas in action as part
of a full-fledged subscription-based session proxy, take a look
at [djaoapp](https://github.com/djaodjin/djaoapp/).
Full documentation for the project is available at
[Read-the-Docs](http://djaodjin-saas.readthedocs.org/)
Development
===========
After cloning the repository, create a virtualenv environment and install
the prerequisites:
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -r testsite/requirements.txt
# Installs Javascript prerequisites to run in the browser
$ make vendor-assets-prerequisites
To use the testsite, you will need to add the payment processor keys
(see [Processor Backends](http://djaodjin-saas.readthedocs.io/en/latest/backends.html))
and Django secret key into a credentials file. Example with
[Stripe](https://stripe.com/):
$ cat ./credentials
SECRET_KEY = "enough_random_data"
STRIPE_PUB_KEY = "your_stripe_public_api_key"
STRIPE_PRIV_KEY = "your_stripe_private_api_key"
It remains to create and [populate the database with required objects](https://djaodjin-saas.readthedocs.io/en/latest/getting-started.html#setting-up-a-software-as-a-service-site).
$ python ./manage.py migrate --run-syncdb --noinput
$ python ./manage.py loaddata testsite/fixtures/initial_data.json
$ python ./manage.py createsuperuser
You can further generate a set of dummy data data to populate the site.
$ python ./manage.py load_test_transactions
Side note: If create your own fixtures file (ex: testsite/fixtures/test_data.json)
and attempt to load them with a Django version *before* 2 while the Python
executable was linked with a SQLite version *after* 3.25, you might stumble upon
the well-known [SQLite 3.26 breaks database migration ForeignKey constraint, leaving __old in db schema](http://djaodjin.com/blog/django-2-2-with-sqlite-3-on-centos-7.blog.html#sqlite-django-compatibility) bug.
Your best bet is to use Django2+ or delete the migrations/ directory.
If all is well then, you are ready to run the server and browse the testsite.
$ python manage.py runserver
# Browse http://localhost:8000/
Implementation Notes
--------------------
The latest versions of django-restframework (>=3.0) implement paginators
disconnected from parameters in views (i.e. no more paginate_by). You will
thus need to define ``PAGE_SIZE`` in your settings.py
$ diff testsite/settings.py
+REST_FRAMEWORK = {
+ 'PAGE_SIZE': 25,
+ 'DEFAULT_PAGINATION_CLASS':
+ 'rest_framework.pagination.PageNumberPagination',
+}
This Django App does not send notification e-mails itself. All major
updates that would result in a e-mail sent trigger signals though. It is
straightforward to send e-mails on a signal trigger in the main
Django project. We provide sample e-mail templates here in the
saas/templates/notification/ directory.
Release Notes
=============
Tested with
- **Python:** 3.7, **Django:** 3.2 ([LTS](https://www.djangoproject.com/download/))
- **Python:** 3.10, **Django:** 4.2 (latest)
- **Python:** 2.7, **Django:** 1.11 (legacy) - use testsite/requirements-legacy.txt
0.20.5
* fixes role request while a role grant is pending
* saves meta information in role
* repares profile/user relationship whenever possible
* shows discount type correctly in template
[previous release notes](changelog)