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:
<pre><code>
$ 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
</code></pre>
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/):
<pre><code>
$ cat ./credentials
SECRET_KEY = "<em>enough_random_data</em>"
STRIPE_PUB_KEY = "<em>your_stripe_public_api_key</em>"
STRIPE_PRIV_KEY = "<em>your_stripe_private_api_key</em>"
</code></pre>
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 <table_name>__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.4
* accounts for upper/lower case email during group buy
* enables filter by provider in /api/pricing
* removes b'' marker in downloads while being py27-compatible
[previous release notes](changelog)
Raw data
{
"_id": null,
"home_page": null,
"name": "djaodjin-saas",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "The DjaoDjin Team <help@djaodjin.com>",
"keywords": "django, stripe, saas, subscriptions, razorpay, plans",
"author": null,
"author_email": "The DjaoDjin Team <help@djaodjin.com>",
"download_url": "https://files.pythonhosted.org/packages/f3/97/a134beadfb8bb10300ec2044a417990aed45783baffb5c5754c28a54394a/djaodjin_saas-0.20.4.tar.gz",
"platform": null,
"description": "DjaoDjin-SaaS\n=============\n\n[](https://djaodjin-saas.readthedocs.io/en/latest/?badge=latest)\n[](https://badge.fury.io/py/djaodjin-saas)\n\ndjaodjin-saas is a Django application that implements the logic to support\nsubscription-based Software-as-a-Service businesses.\n\nMajor Features:\n\n- Separate billing profiles and authenticated users\n- Double entry book keeping ledger\n- Flexible security framework\n\nThis project contains bare bone templates which are compatible with Django\nand Jinja2 template engines. To see djaodjin-saas in action as part\nof a full-fledged subscription-based session proxy, take a look\nat [djaoapp](https://github.com/djaodjin/djaoapp/).\n\nFull documentation for the project is available at\n[Read-the-Docs](http://djaodjin-saas.readthedocs.org/)\n\n\nDevelopment\n===========\n\nAfter cloning the repository, create a virtualenv environment and install\nthe prerequisites:\n\n<pre><code>\n $ python -m venv .venv\n $ source .venv/bin/activate\n $ pip install -r testsite/requirements.txt\n\n # Installs Javascript prerequisites to run in the browser\n $ make vendor-assets-prerequisites\n\n</code></pre>\n\nTo use the testsite, you will need to add the payment processor keys\n(see [Processor Backends](http://djaodjin-saas.readthedocs.io/en/latest/backends.html))\nand Django secret key into a credentials file. Example with\n[Stripe](https://stripe.com/):\n\n<pre><code>\n $ cat ./credentials\n\n SECRET_KEY = \"<em>enough_random_data</em>\"\n STRIPE_PUB_KEY = \"<em>your_stripe_public_api_key</em>\"\n STRIPE_PRIV_KEY = \"<em>your_stripe_private_api_key</em>\"\n\n</code></pre>\n\nIt 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).\n\n $ python ./manage.py migrate --run-syncdb --noinput\n $ python ./manage.py loaddata testsite/fixtures/initial_data.json\n $ python ./manage.py createsuperuser\n\nYou can further generate a set of dummy data data to populate the site.\n\n $ python ./manage.py load_test_transactions\n\nSide note: If create your own fixtures file (ex: testsite/fixtures/test_data.json)\nand attempt to load them with a Django version *before* 2 while the Python\nexecutable was linked with a SQLite version *after* 3.25, you might stumble upon\nthe well-known [SQLite 3.26 breaks database migration ForeignKey constraint, leaving <table_name>__old in db schema](http://djaodjin.com/blog/django-2-2-with-sqlite-3-on-centos-7.blog.html#sqlite-django-compatibility) bug.\nYour best bet is to use Django2+ or delete the migrations/ directory.\n\nIf all is well then, you are ready to run the server and browse the testsite.\n\n $ python manage.py runserver\n\n # Browse http://localhost:8000/\n\n\nImplementation Notes\n--------------------\n\nThe latest versions of django-restframework (>=3.0) implement paginators\ndisconnected from parameters in views (i.e. no more paginate_by). You will\nthus need to define ``PAGE_SIZE`` in your settings.py\n\n $ diff testsite/settings.py\n +REST_FRAMEWORK = {\n + 'PAGE_SIZE': 25,\n + 'DEFAULT_PAGINATION_CLASS':\n + 'rest_framework.pagination.PageNumberPagination',\n +}\n\nThis Django App does not send notification e-mails itself. All major\nupdates that would result in a e-mail sent trigger signals though. It is\nstraightforward to send e-mails on a signal trigger in the main\nDjango project. We provide sample e-mail templates here in the\nsaas/templates/notification/ directory.\n\n\nRelease Notes\n=============\n\nTested with\n\n- **Python:** 3.7, **Django:** 3.2 ([LTS](https://www.djangoproject.com/download/))\n- **Python:** 3.10, **Django:** 4.2 (latest)\n- **Python:** 2.7, **Django:** 1.11 (legacy) - use testsite/requirements-legacy.txt\n\n0.20.4\n\n * accounts for upper/lower case email during group buy\n * enables filter by provider in /api/pricing\n * removes b'' marker in downloads while being py27-compatible\n\n[previous release notes](changelog)\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Django application for software-as-service and subscription businesses",
"version": "0.20.4",
"project_urls": {
"changelog": "https://github.com/djaodjin/djaodjin-saas/changelog",
"documentation": "https://djaodjin-saas.readthedocs.io/",
"repository": "https://github.com/djaodjin/djaodjin-saas"
},
"split_keywords": [
"django",
" stripe",
" saas",
" subscriptions",
" razorpay",
" plans"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b56e98e4386baab309dc73b46e2d1911ff8a46f6d6978000944f7c44eb0e8aa",
"md5": "df7781fedc9a65a3555a92b0202f4c05",
"sha256": "ddbfa5ad27f9c37fd3c06588d6036d79b0fbc42cf5241cf8d546dbda00a974da"
},
"downloads": -1,
"filename": "djaodjin_saas-0.20.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df7781fedc9a65a3555a92b0202f4c05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 466751,
"upload_time": "2024-05-01T23:31:16",
"upload_time_iso_8601": "2024-05-01T23:31:16.911617Z",
"url": "https://files.pythonhosted.org/packages/7b/56/e98e4386baab309dc73b46e2d1911ff8a46f6d6978000944f7c44eb0e8aa/djaodjin_saas-0.20.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f397a134beadfb8bb10300ec2044a417990aed45783baffb5c5754c28a54394a",
"md5": "cb1b07e887d7472647a128c1a9dc836b",
"sha256": "cfcee8d3b427883b06bdf50dd4e5aa2698f598d1da14c5dcb97c8c21d4cff939"
},
"downloads": -1,
"filename": "djaodjin_saas-0.20.4.tar.gz",
"has_sig": false,
"md5_digest": "cb1b07e887d7472647a128c1a9dc836b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 321672,
"upload_time": "2024-05-01T23:31:19",
"upload_time_iso_8601": "2024-05-01T23:31:19.380117Z",
"url": "https://files.pythonhosted.org/packages/f3/97/a134beadfb8bb10300ec2044a417990aed45783baffb5c5754c28a54394a/djaodjin_saas-0.20.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 23:31:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "djaodjin",
"github_project": "djaodjin-saas",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "djaodjin-saas"
}
JSON
