[](https://badge.fury.io/py/django-hurricane)  [](https://sonarcloud.io/summary/new_code?id=django-hurricane_django-hurricane) [](https://coveralls.io/github/django-hurricane/django-hurricane?branch=main) [](https://django-hurricane.readthedocs.io/en/latest/) [](https://opensource.org/licenses/MIT) [](https://github.com/psf/black)
--------------------------------------------------------------------------------
<br />
<br />
<!-- PROJECT LOGO -->
<br />
<div align="center">
<h3 align="center">Hurricane</h3>
<p align="center">
An initiative to fit Django perfectly with Kubernetes. It is supposed to cover many capabilities in order to run
Django in a cloud-native environment, including a Tornado-powered Django app server.
<br />
<a href="https://django-hurricane.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://django-hurricane.io/">Hurricane website</a>
·
<a href="https://django-hurricane.readthedocs.io/en/latest/usage.html">User's guide</a>
·
<a href="https://django-hurricane.io/basic-app/">Guide to the first Hurricane-based Application</a>
</p>
</div>
## Intro
Django was developed with the *batteries included*-approach and already handles most of the challenges around
web development with grace. It was initially developed at a time when web applications got deployed and run on a server
(physical or virtual). With its *pragmatic design* it enabled many developers to keep up with changing requirements,
performance and maintenance work.
However, service architectures have become quite popular for complex applications in the past few years. They provide
a modular style based on the philosophy of dividing overwhelming software projects into smaller and more controllable
parts. The advantage of highly specialized applications gained prominence among developers, but introduces new
challenges to the IT-operation.
However, with the advent of Kubernetes and the cloud-native development philosophy a couple of new possibilities emerged
to run those service-based applications even better. Kubernetes is a wonderful answer for just as many IT-operation
requirements as Django is for web development. The inherent monolithic design of Django can be tempting to roll out
recurring operation patterns with each application. It's not about getting Django to run in a
Kubernetes cluster (you may already solved this), it's about integrating Django as tightly as possible with Kubernetes
in order to harness the full power of that platform. Creating the most robust, scalable and secure applications
with Django by leveraging the existing expertise of our favorite framework is the main goal of this initiative.
Hurricane is supposed to make the most out of the existing Django ecosystem without reinventing the wheel.
We will collect best-practices and opinions about how to run Django in Kubernetes and put them on Hurricane's roadmap.
### Application Server
Why another app server instead of *uwsgi*, *gunicorn* or *mod_wsgi*? We need a cloud-native app server which is
much more tidily coupled to the Django application itself. Think of special URL routes for Kubernetes probes! Building a
special View in each and every Django application is not an appropriate solution. What about the Kubernetes Metrics API?
That's all something we **don't** want to take care of in our Django code.
Those traditional app servers (i.e. uwsgi et.al.) have a highly optimized process model for bare-server deployments with
many CPUs, multiple threads and so on. In Kubernetes the scaling of an application is done through the Replication-value
in a workload description manifest. This is no longer something we configure with app server parameters.
## Installation
Hurricane can be installed from a Python Package Index:
```bash
pip3 install django-hurricane
```
Add *"hurricane"* to your *INSTALLED_APPS*:
```python
INSTALLED_APPS += (
'hurricane',
)
```
You can start the Hurricane server with a following command:
```python
python manage.py serve --autoreload --static
```
The ouput of this command looks as following:
```
System check identified some issues:
2022-05-04 02:19:07,521 INFO hurricane.server.general Tornado-powered Django web server
2022-05-04 02:19:07,521 INFO hurricane.server.general Starting probe application running on port 8001 with route liveness-probe: /alive, readiness-probe: /ready, startup-probe: /startup
2022-05-04 02:19:07,523 INFO hurricane.server.general Starting HTTP Server on port 8000
2022-05-04 02:19:07,524 INFO hurricane.server.general Startup time is 0.0026285648345947266 seconds
```
There are many options that can be used in a combination with the serve command. Please refer to the [documentation](https://django-hurricane.readthedocs.io/en/latest/usage.html) to learn more about the options.
Django-hurricane works best in combination with Kubernetes, as it includes the inbuilt health-probes, i.e. liveness, readiness and startup probes. Additionally, it is possible to implement custom checks. These checks will be executed after the standard django checks. Follow our guide to learn [how to write a custom check](https://django-hurricane.io/custom-checks/).
## Commercial Support
Hurricane is developed and maintained by [Blueshoe](https://www.blueshoe.de).
If you need any help implementing with hurricane or you want to tell us about the use-case, how you use hurricane, please contact us: hurricane@blueshoe.de.
Raw data
{
"_id": null,
"home_page": "https://django-hurricane.io/",
"name": "django-hurricane",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "django,kubernetes,hurricane",
"author": "Michael Schilonka",
"author_email": "michael@blueshoe.io",
"download_url": "https://files.pythonhosted.org/packages/ff/1e/132e45db448c55e99afcfa62737071efd0f9e45c83777097554a8979dee9/django_hurricane-1.5.0.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/django-hurricane)  [](https://sonarcloud.io/summary/new_code?id=django-hurricane_django-hurricane) [](https://coveralls.io/github/django-hurricane/django-hurricane?branch=main) [](https://django-hurricane.readthedocs.io/en/latest/) [](https://opensource.org/licenses/MIT) [](https://github.com/psf/black)\n--------------------------------------------------------------------------------\n<br />\n<br />\n\n\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <h3 align=\"center\">Hurricane</h3>\n\n <p align=\"center\">\n An initiative to fit Django perfectly with Kubernetes. It is supposed to cover many capabilities in order to run \n Django in a cloud-native environment, including a Tornado-powered Django app server.\n <br />\n <a href=\"https://django-hurricane.readthedocs.io/en/latest/\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://django-hurricane.io/\">Hurricane website</a>\n \u00b7\n <a href=\"https://django-hurricane.readthedocs.io/en/latest/usage.html\">User's guide</a>\n \u00b7\n <a href=\"https://django-hurricane.io/basic-app/\">Guide to the first Hurricane-based Application</a>\n </p>\n</div> \n\n## Intro\n\nDjango was developed with the *batteries included*-approach and already handles most of the challenges around \nweb development with grace. It was initially developed at a time when web applications got deployed and run on a server \n(physical or virtual). With its *pragmatic design* it enabled many developers to keep up with changing requirements, \nperformance and maintenance work. \nHowever, service architectures have become quite popular for complex applications in the past few years. They provide\na modular style based on the philosophy of dividing overwhelming software projects into smaller and more controllable \nparts. The advantage of highly specialized applications gained prominence among developers, but introduces new \nchallenges to the IT-operation. \nHowever, with the advent of Kubernetes and the cloud-native development philosophy a couple of new possibilities emerged\nto run those service-based applications even better. Kubernetes is a wonderful answer for just as many IT-operation \nrequirements as Django is for web development. The inherent monolithic design of Django can be tempting to roll out \nrecurring operation patterns with each application. It's not about getting Django to run in a \nKubernetes cluster (you may already solved this), it's about integrating Django as tightly as possible with Kubernetes \nin order to harness the full power of that platform. Creating the most robust, scalable and secure applications \nwith Django by leveraging the existing expertise of our favorite framework is the main goal of this initiative.\n\nHurricane is supposed to make the most out of the existing Django ecosystem without reinventing the wheel. \nWe will collect best-practices and opinions about how to run Django in Kubernetes and put them on Hurricane's roadmap.\n\n### Application Server\nWhy another app server instead of *uwsgi*, *gunicorn* or *mod_wsgi*? We need a cloud-native app server which is\nmuch more tidily coupled to the Django application itself. Think of special URL routes for Kubernetes probes! Building a\nspecial View in each and every Django application is not an appropriate solution. What about the Kubernetes Metrics API?\nThat's all something we **don't** want to take care of in our Django code. \nThose traditional app servers (i.e. uwsgi et.al.) have a highly optimized process model for bare-server deployments with\nmany CPUs, multiple threads and so on. In Kubernetes the scaling of an application is done through the Replication-value\nin a workload description manifest. This is no longer something we configure with app server parameters.\n \n## Installation\n\nHurricane can be installed from a Python Package Index:\n```bash\npip3 install django-hurricane\n```\n\nAdd *\"hurricane\"* to your *INSTALLED_APPS*: \n```python\nINSTALLED_APPS += (\n 'hurricane',\n)\n```\nYou can start the Hurricane server with a following command:\n```python\npython manage.py serve --autoreload --static\n```\nThe ouput of this command looks as following:\n\n```\nSystem check identified some issues:\n\n2022-05-04 02:19:07,521 INFO hurricane.server.general Tornado-powered Django web server\n2022-05-04 02:19:07,521 INFO hurricane.server.general Starting probe application running on port 8001 with route liveness-probe: /alive, readiness-probe: /ready, startup-probe: /startup\n2022-05-04 02:19:07,523 INFO hurricane.server.general Starting HTTP Server on port 8000\n2022-05-04 02:19:07,524 INFO hurricane.server.general Startup time is 0.0026285648345947266 seconds\n```\n\nThere are many options that can be used in a combination with the serve command. Please refer to the [documentation](https://django-hurricane.readthedocs.io/en/latest/usage.html) to learn more about the options.\n\nDjango-hurricane works best in combination with Kubernetes, as it includes the inbuilt health-probes, i.e. liveness, readiness and startup probes. Additionally, it is possible to implement custom checks. These checks will be executed after the standard django checks. Follow our guide to learn [how to write a custom check](https://django-hurricane.io/custom-checks/).\n\n\n## Commercial Support\nHurricane is developed and maintained by [Blueshoe](https://www.blueshoe.de). \nIf you need any help implementing with hurricane or you want to tell us about the use-case, how you use hurricane, please contact us: hurricane@blueshoe.de.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Kubernetes Native Stack Specifically Created For Django",
"version": "1.5.0",
"project_urls": {
"Documentation": "https://django-hurricane.readthedocs.io/en/latest/",
"Homepage": "https://django-hurricane.io/",
"Repository": "https://github.com/django-hurricane/django-hurricane"
},
"split_keywords": [
"django",
"kubernetes",
"hurricane"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d9b0ea1c46b717301c6853458b4dd88288dfa84f3d3bdafaba4fe2b85bbc25e",
"md5": "19aa761b72ae8ff45b8253e3074c5dd4",
"sha256": "2012da4c8790d5469fd4c40874819f28a6dc15d0468b69705708f4a67ee2fa7c"
},
"downloads": -1,
"filename": "django_hurricane-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19aa761b72ae8ff45b8253e3074c5dd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 37856,
"upload_time": "2024-02-15T18:22:22",
"upload_time_iso_8601": "2024-02-15T18:22:22.800206Z",
"url": "https://files.pythonhosted.org/packages/8d/9b/0ea1c46b717301c6853458b4dd88288dfa84f3d3bdafaba4fe2b85bbc25e/django_hurricane-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff1e132e45db448c55e99afcfa62737071efd0f9e45c83777097554a8979dee9",
"md5": "2ec3d01b71656a714d72088ded785e09",
"sha256": "19094240a0a3f2760eadc52fb713007779cb719ad0d62e51edac8cdb8e603cc7"
},
"downloads": -1,
"filename": "django_hurricane-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "2ec3d01b71656a714d72088ded785e09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 30908,
"upload_time": "2024-02-15T18:22:32",
"upload_time_iso_8601": "2024-02-15T18:22:32.727463Z",
"url": "https://files.pythonhosted.org/packages/ff/1e/132e45db448c55e99afcfa62737071efd0f9e45c83777097554a8979dee9/django_hurricane-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 18:22:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-hurricane",
"github_project": "django-hurricane",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "django-hurricane"
}
JSON
