Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pauloxnet/udjango
A single file Django micro project created for demonstration purposes to be used in the same way as other Python frameworks.
https://github.com/pauloxnet/udjango
Last synced: 12 days ago
JSON representation
A single file Django micro project created for demonstration purposes to be used in the same way as other Python frameworks.
- Host: GitHub
- URL: https://github.com/pauloxnet/udjango
- Owner: pauloxnet
- License: bsd-3-clause
- Created: 2023-10-19T15:15:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-12T19:42:21.000Z (26 days ago)
- Last Synced: 2024-10-20T20:30:35.806Z (18 days ago)
- Language: Python
- Size: 27.3 KB
- Stars: 165
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧬 μDjango (micro Django)
A single file Django micro project created for demonstration purposes to be used in the same way as other Python frameworks.
## 🏛️ History
I created this code while working on an improvement to [Will Vincent](https://github.com/wsvincent)'s [Django Microframework](https://github.com/wsvincent/django-microframework) repository, which was itself inspired by a talk that [Carlton Gibson](https://github.com/carltongibson) gave at [DjangoCon US 2019](https://2019.djangocon.us/talks/using-django-as-a-micro-framework-on-the/): _"[Using Django as a Micro-Framework](https://www.youtube.com/watch?v=w9cYEovduWI)"_.
Starting from that demonstration code I thought of a `Django` micro application that could be used in the same way as a minimal application used in other `Python` frameworks such as `Flask` or `FastAPI`.
I presented this code during the [first sprint day](https://2023.djangocon.us/sprints/thursday/) of [DjangoCon US 2023](https://2023.djangocon.us), together with [Will Vincent](https://github.com/wsvincent) and seeing the appreciation I decided to publish it in this repository.
[{loading=lazy}](https://fosstodon.org/@paulox/111262287902120294)
> μDjango presentation during the DjangoCon US 2023 sprints in Durham, North Carolina
## 💻 Set Up
### Python
We need a stable and supported version of Python 3 (tested with Python 3.10-3.13):
```console
$ python3 --version
```
```console
Python 3.13.0
```
### ⚗️ Virtualenv
Creating and activating the virtual environment:
```console
$ python3 -m venv .venv
$ source .venv/bin/activate
```
### 🧩 Requirements
Installing the required python packages in the virtual environments:
```console
$ python -m pip install django uvicorn
```
```console
Collecting django
Using cached Django-5.1.2-py3-none-any.whl.metadata (4.2 kB)
Collecting uvicorn
Using cached uvicorn-0.31.1-py3-none-any.whl.metadata (6.6 kB)
Collecting asgiref<4,>=3.8.1 (from django)
Using cached asgiref-3.8.1-py3-none-any.whl.metadata (9.3 kB)
Collecting sqlparse>=0.3.1 (from django)
Using cached sqlparse-0.5.1-py3-none-any.whl.metadata (3.9 kB)
Collecting click>=7.0 (from uvicorn)
Using cached click-8.1.7-py3-none-any.whl.metadata (3.0 kB)
Collecting h11>=0.8 (from uvicorn)
Using cached h11-0.14.0-py3-none-any.whl.metadata (8.2 kB)
Using cached Django-5.1.2-py3-none-any.whl (8.3 MB)
Using cached uvicorn-0.31.1-py3-none-any.whl (63 kB)
Using cached asgiref-3.8.1-py3-none-any.whl (23 kB)
Using cached click-8.1.7-py3-none-any.whl (97 kB)
Using cached h11-0.14.0-py3-none-any.whl (58 kB)
Using cached sqlparse-0.5.1-py3-none-any.whl (44 kB)
Installing collected packages: sqlparse, h11, click, asgiref, uvicorn, django
Successfully installed asgiref-3.8.1 click-8.1.7 django-5.1.2 h11-0.14.0 sqlparse-0.5.1 uvicorn-0.31.1
```
## 🧮 Code
Create a new file called `main.py` and update it as follows:
```python
from django import conf, http, urls
from django.core.handlers import asgi
conf.settings.configure(ALLOWED_HOSTS="*", ROOT_URLCONF=__name__)
app = asgi.ASGIHandler()
async def root(request):
return http.JsonResponse({"message": "Hello World"})
urlpatterns = [urls.path("", root)]
```
## 🏃 Run
Start the server with `uvicorn` command.
```console
$ uvicorn main:app --reload
```
```ini
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [...] using StatReload
INFO: Started server process [...]
INFO: Waiting for application startup.
INFO: ASGI 'lifespan' protocol appears unsupported.
INFO: Application startup complete.
```
## 🔬 Check it
Open your browser at [http://127.0.0.1:8000](http://127.0.0.1:8000)
You will see the JSON response as:
```json
{ "message": "Hello World" }
```
## ⚠️ Disclaimer
This code is for demonstration purposes only and should not be used in production. However, the code is released without any guarantee from the author and no liability can be attributed. Use at your own risk.
## 💬 Sharing
Here's where the **μDjango** _(micro Django)_ project was shared online in case you want to re-share it.
### 🦣 Mastodon
- [https://fosstodon.org/@paulox/111262287902120294](https://fosstodon.org/@paulox/111262287902120294)
### 🐦️ Twitter
- [https://twitter.com/pauloxnet/status/1715020317372891574](https://twitter.com/pauloxnet/status/1715020317372891574)
### 📣 Django forum
- [https://forum.djangoproject.com/t/django-micro-django/24681](https://forum.djangoproject.com/t/django-micro-django/24681)
## ⚖️ License
**μDjango** is licensed under the [BSD 3-Clause License](https://github.com/pauloxnet/uDjango/blob/main/LICENSE).
## 👥 Authors
### 👤 Paolo Melchiorre
- 🌍 Blog: [www.paulox.net](https://www.paulox.net)
- 🐙 Github: [@[email protected]](https://github.com/pauloxnet)
- 🦣 Mastodon: [@[email protected]](https://fosstodon.org/@paulox)
- 🐦️ Twitter: [@[email protected]](https://twitter.com/pauloxnet)