dynaconf Télécharger - dynaconf Téléchargement du code source

dynaconf

Python

3.2.6

Télécharger

Caractéristiques

Inspiré du guide de candidature en 12 facteurs
Gestion des paramètres (valeurs par défaut, validation, analyse, modèles)
Protection des informations sensibles (mots de passe/jetons)
Plusieurs formats de fichiers toml|yaml|json|ini|py et également des chargeurs personnalisables.
Prise en charge complète des variables d'environnement pour remplacer les paramètres existants (prise en charge dotenv incluse).
Système en couches en option pour plusieurs environnements [default, development, testing, production]
Prise en charge intégrée de Hashicorp Vault et Redis en tant que paramètres et stockage de secrets.
Extensions intégrées pour les frameworks Web Django et Flask .
CLI pour les opérations courantes telles que init, list, write, validate, export .
documentation complète sur https://dynaconf.com

Installer

$ pip install dynaconf

Initialiser Dynaconf sur le répertoire racine du projet

 $ cd path/to/your/project/

$ dynaconf init -f toml

  Configuring your Dynaconf environment
------------------------------------------
? The file `config.py` was generated.

?️  settings.toml created to hold your settings.

? .secrets.toml created to hold your secrets.

? the .secrets.* is also included in `.gitignore`
  beware to not push your secrets to a public repo.

? Dynaconf is configured! read more on https://dynaconf.com

CONSEIL : Vous pouvez sélectionner toml|yaml|json|ini|py sur dynaconf init -f <fileformat> toml est le format par défaut et également le format le plus recommandé pour la configuration.

Dynaconf init crée les fichiers suivants

 .
├── config.py       # This is from where you import your settings object (required)
├── .secrets.toml   # This is to hold sensitive data like passwords and tokens (optional)
└── settings.toml   # This is to hold your application settings (optional)

Sur le fichier config.py Dynaconf init génère le code suivant

 from dynaconf import Dynaconf

settings = Dynaconf (
    envvar_prefix = "DYNACONF" ,  # export envvars with `export DYNACONF_FOO=bar`.
    settings_files = [ 'settings.yaml' , '.secrets.yaml' ],  # Load files in the given order.
)

CONSEIL : Vous pouvez créer les fichiers vous-même au lieu d'utiliser la commande init comme indiqué ci-dessus et vous pouvez donner le nom de votre choix au lieu du config.py par défaut (le fichier doit être dans votre chemin python importable) - Voir plus d'options que vous pouvez passer à l'initialiseur de classe Dynaconf sur https://dynaconf.com

Utiliser Dynaconf

Mettez vos paramètres sur settings.{toml|yaml|ini|json|py}

 username = " admin "
port = 5555
database = { name = ' mydb ' , schema = ' main ' }

Mettez les informations sensibles sur .secrets.{toml|yaml|ini|json|py}

 password = " secret123 "

IMPORTANT : la commande dynaconf init place le .secrets.* dans votre .gitignore pour éviter qu'il ne soit exposé sur des dépôts publics, mais il est de votre responsabilité de le garder en sécurité dans votre environnement local. La recommandation pour les environnements de production est également d'utiliser le en prise en charge du service Hashicorp Vault pour le mot de passe et les jetons.

En option, vous pouvez désormais utiliser des variables d'environnement pour remplacer les valeurs par exécution ou par environnement.

 # override `port` from settings.toml file and automatically casts as `int` value.
export DYNACONF_PORT=9900

Sur votre code, importez l'objet settings

 from path . to . project . config import settings

# Reading the settings

settings . username == "admin"  # dot notation with multi nesting support
settings . PORT == 9900  # case insensitive
settings [ 'password' ] == "secret123"  # dict like access
settings . get ( "nonexisting" , "default value" )  # Default values just like a dict
settings . databases . name == "mydb"  # Nested key traversing
settings [ 'databases.schema' ] == "main"  # Nested key traversing