# pydjantic
[](https://github.com/ErhoSen/pydjantic/actions)
[](https://codecov.io/gh/ErhoSen/pydjantic)
[](https://pypi.org/project/pydjantic/)
[](https://github.com/erhosen-libs/pydjantic)
[](https://github.com/erhosen-libs/pydjantic/blob/master/LICENSE)
[](https://github.com/psf/black)
Use Pydantic Settings in your Django application.
## Introduction
If you are tired of the mess in your Django Settings - I feel your pain:
* Ridiculously long `settings.py` file, with ASCII-art separation
* `from common import *` Python [anti-pattern](https://www.geeksforgeeks.org/why-import-star-in-python-is-a-bad-idea/)
* `try: <import> except: ImportError` Python [anti-pattern](https://stackoverflow.com/questions/14050281/how-to-check-if-a-python-module-exists-without-importing-it)
* `base.py`, `production.py`, `local.py`, `domain.py` - bunch of unrelated modules that override each other
* [django-environ](https://github.com/joke2k/django-environ) library, that do even worse...
On the other hand we have [Pydantic Settings](https://pydantic-docs.helpmanual.io/usage/settings/),
which is de-facto standard for all non-django projects.
If you love Pydantic settings management approach, **Pydjantic** is a right tool for you.
**Pydjantic** allows you to define your settings in familiar way - just inherit from `BaseSettings`:
```py
from typing import List
from pydantic import BaseSettings, Field
from pydantic.fields import Undefined
from pydjantic import to_django
class GeneralSettings(BaseSettings):
SECRET_KEY: str = Field(default=Undefined, env='DJANGO_SECRET_KEY')
DEBUG: bool = Field(default=False, env='DEBUG')
INSTALLED_APPS: List[str] = [
'django.contrib.admin',
'django.contrib.auth',
]
LANGUAGE_CODE: str = 'en-us'
USE_TZ: bool = True
class StaticSettings(BaseSettings):
STATIC_URL: str = '/static/'
STATIC_ROOT: str = 'staticfiles'
class SentrySettings(BaseSettings):
SENTRY_DSN: str = Field(default=Undefined, env='SENTRY_DSN')
class ProjectSettings(GeneralSettings, StaticSettings, SentrySettings):
pass
to_django(ProjectSettings())
```
You can create as many classes/modules as you want, to achieve perfect settings' management.
Divide your settings by domains, and then create final `ProjectSettings` class, that inherits from these domains.
Provide the instance of `ProjectSettings` to `to_django` function.
That's all, your django settings will work as expected.
## Installation
Install using `pip install -U pydjantic` or `poetry add pydjantic`.
## Example
In the `/demo` directory you can find a [working Django app](https://github.com/erhosen-libs/pydjantic/tree/master/demo) with [pydjantic settings](https://github.com/erhosen-libs/pydjantic/blob/master/demo/demo/settings.py).
## Database configuration
**Pydjantic** comes with a special helper for managing DB configs - `BaseDBConfig`. See example below:
```python
from pydantic import Field, PostgresDsn
from pydjantic import BaseDBConfig
class DatabaseConfig(BaseDBConfig):
default: PostgresDsn = Field(default="postgres://user:password@hostname:5432/dbname", env="DATABASE_URL")
db_settings = DatabaseConfig()
assert db_settings.default == {
'CONN_MAX_AGE': 0,
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'HOST': 'hostname',
'NAME': 'dbname',
'PASSWORD': 'password',
'PORT': 5432,
'USER': 'user',
}
```
Also, you can define database configurations directly:
```python
from pydantic import BaseSettings, Field
class PostgresDB(BaseSettings):
ENGINE: str = 'django.db.backends.postgresql_psycopg2'
HOST: str = Field(default='localhost', env='DATABASE_HOST')
NAME: str = Field(default='dbname', env='DATABASE_NAME')
PASSWORD: str = Field(default='password', env='DATABASE_PASSWORD')
PORT: int = Field(default=5432, env='DATABASE_PORT')
USER: str = Field(default='user', env='DATABASE_USER')
OPTIONS: dict = Field(default={}, env='DATABASE_OPTIONS')
CONN_MAX_AGE: int = Field(default=0, env='DATABASE_CONN_MAX_AGE')
class DatabaseConfig(BaseSettings):
default = PostgresDB()
```
Or mix these approaches:
```python
class DatabaseConfig(BaseDBConfig):
default = Field(default="postgres://user:password@hostname:5432/dbname")
replica = PostgresDB()
```
For more examples see [tests](tests/test_db_config.py).
Transformation from dsn to django format is done by [dj-database-url](https://pypi.org/project/dj-database-url/) library.
Raw data
{
"_id": null,
"home_page": "https://github.com/ErhoSen/pydjantic",
"name": "pydjantic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "pydantic,django,PydanticSettings,settings",
"author": "Vladimir Vyazovetskov",
"author_email": "erhosen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/3f/220d1335e682f0c30d2aae7dbaea9708bd19905109914970e5bff04c95a5/pydjantic-1.1.4.tar.gz",
"platform": null,
"description": "# pydjantic\n[](https://github.com/ErhoSen/pydjantic/actions)\n[](https://codecov.io/gh/ErhoSen/pydjantic)\n[](https://pypi.org/project/pydjantic/)\n[](https://github.com/erhosen-libs/pydjantic)\n[](https://github.com/erhosen-libs/pydjantic/blob/master/LICENSE)\n[](https://github.com/psf/black)\n\nUse Pydantic Settings in your Django application.\n\n![Pydjantc django settings](https://github.com/erhosen-libs/pydjantic/raw/master/images/pydjantic.png \"Pydjantc django settings\")\n\n## Introduction\n\nIf you are tired of the mess in your Django Settings - I feel your pain:\n* Ridiculously long `settings.py` file, with ASCII-art separation\n* `from common import *` Python [anti-pattern](https://www.geeksforgeeks.org/why-import-star-in-python-is-a-bad-idea/)\n* `try: <import> except: ImportError` Python [anti-pattern](https://stackoverflow.com/questions/14050281/how-to-check-if-a-python-module-exists-without-importing-it)\n* `base.py`, `production.py`, `local.py`, `domain.py` - bunch of unrelated modules that override each other\n* [django-environ](https://github.com/joke2k/django-environ) library, that do even worse...\n\nOn the other hand we have [Pydantic Settings](https://pydantic-docs.helpmanual.io/usage/settings/),\nwhich is de-facto standard for all non-django projects.\n\nIf you love Pydantic settings management approach, **Pydjantic** is a right tool for you.\n\n**Pydjantic** allows you to define your settings in familiar way - just inherit from `BaseSettings`:\n```py\nfrom typing import List\n\nfrom pydantic import BaseSettings, Field\nfrom pydantic.fields import Undefined\nfrom pydjantic import to_django\n\nclass GeneralSettings(BaseSettings):\n SECRET_KEY: str = Field(default=Undefined, env='DJANGO_SECRET_KEY')\n DEBUG: bool = Field(default=False, env='DEBUG')\n INSTALLED_APPS: List[str] = [\n 'django.contrib.admin',\n 'django.contrib.auth',\n ]\n LANGUAGE_CODE: str = 'en-us'\n USE_TZ: bool = True\n\n\nclass StaticSettings(BaseSettings):\n STATIC_URL: str = '/static/'\n STATIC_ROOT: str = 'staticfiles'\n\n\nclass SentrySettings(BaseSettings):\n SENTRY_DSN: str = Field(default=Undefined, env='SENTRY_DSN')\n\n\nclass ProjectSettings(GeneralSettings, StaticSettings, SentrySettings):\n pass\n\n\nto_django(ProjectSettings())\n```\nYou can create as many classes/modules as you want, to achieve perfect settings' management.\nDivide your settings by domains, and then create final `ProjectSettings` class, that inherits from these domains.\n\nProvide the instance of `ProjectSettings` to `to_django` function.\nThat's all, your django settings will work as expected.\n\n## Installation\n\nInstall using `pip install -U pydjantic` or `poetry add pydjantic`.\n\n## Example\nIn the `/demo` directory you can find a [working Django app](https://github.com/erhosen-libs/pydjantic/tree/master/demo) with [pydjantic settings](https://github.com/erhosen-libs/pydjantic/blob/master/demo/demo/settings.py).\n\n## Database configuration\n\n**Pydjantic** comes with a special helper for managing DB configs - `BaseDBConfig`. See example below:\n```python\nfrom pydantic import Field, PostgresDsn\nfrom pydjantic import BaseDBConfig\n\n\nclass DatabaseConfig(BaseDBConfig):\n default: PostgresDsn = Field(default=\"postgres://user:password@hostname:5432/dbname\", env=\"DATABASE_URL\")\n\ndb_settings = DatabaseConfig()\nassert db_settings.default == {\n 'CONN_MAX_AGE': 0,\n 'ENGINE': 'django.db.backends.postgresql_psycopg2',\n 'HOST': 'hostname',\n 'NAME': 'dbname',\n 'PASSWORD': 'password',\n 'PORT': 5432,\n 'USER': 'user',\n}\n```\n\nAlso, you can define database configurations directly:\n```python\nfrom pydantic import BaseSettings, Field\n\nclass PostgresDB(BaseSettings):\n ENGINE: str = 'django.db.backends.postgresql_psycopg2'\n HOST: str = Field(default='localhost', env='DATABASE_HOST')\n NAME: str = Field(default='dbname', env='DATABASE_NAME')\n PASSWORD: str = Field(default='password', env='DATABASE_PASSWORD')\n PORT: int = Field(default=5432, env='DATABASE_PORT')\n USER: str = Field(default='user', env='DATABASE_USER')\n OPTIONS: dict = Field(default={}, env='DATABASE_OPTIONS')\n CONN_MAX_AGE: int = Field(default=0, env='DATABASE_CONN_MAX_AGE')\n\nclass DatabaseConfig(BaseSettings):\n default = PostgresDB()\n```\n\nOr mix these approaches:\n```python\nclass DatabaseConfig(BaseDBConfig):\n default = Field(default=\"postgres://user:password@hostname:5432/dbname\")\n replica = PostgresDB()\n```\n\nFor more examples see [tests](tests/test_db_config.py).\n\nTransformation from dsn to django format is done by [dj-database-url](https://pypi.org/project/dj-database-url/) library.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pydantic Settings for Django",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/ErhoSen/pydjantic",
"Repository": "https://github.com/ErhoSen/pydjantic"
},
"split_keywords": [
"pydantic",
"django",
"pydanticsettings",
"settings"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2095833fdf1e444566c134800697acf7121dbccfa81a07f625640611e395ba1c",
"md5": "a547f60eef4e254d41d5fb3ab46ac9c3",
"sha256": "a717812f708c463966c70b6d9245af5724bad41cf19798d86bf98af8ec298d81"
},
"downloads": -1,
"filename": "pydjantic-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a547f60eef4e254d41d5fb3ab46ac9c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 6037,
"upload_time": "2024-01-01T16:42:11",
"upload_time_iso_8601": "2024-01-01T16:42:11.809353Z",
"url": "https://files.pythonhosted.org/packages/20/95/833fdf1e444566c134800697acf7121dbccfa81a07f625640611e395ba1c/pydjantic-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce3f220d1335e682f0c30d2aae7dbaea9708bd19905109914970e5bff04c95a5",
"md5": "f5df1fb31a5daf5da3c879c5405da56d",
"sha256": "9d3e3d830d7f58a98a5d02d2d855e1c4b9bf277b05f2e451efdb31783fc27718"
},
"downloads": -1,
"filename": "pydjantic-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "f5df1fb31a5daf5da3c879c5405da56d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4617,
"upload_time": "2024-01-01T16:42:13",
"upload_time_iso_8601": "2024-01-01T16:42:13.495393Z",
"url": "https://files.pythonhosted.org/packages/ce/3f/220d1335e682f0c30d2aae7dbaea9708bd19905109914970e5bff04c95a5/pydjantic-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 16:42:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ErhoSen",
"github_project": "pydjantic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pydjantic"
}
JSON
