Ravenports generated: 16 Apr 2024 22:24
[ravenports.git] / bucket_89 / python-django-appconf
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-django-appconf
4 VERSION=                1.0.6
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Django configure defaults helper class (3.11)
8 SDESC[v12]=             Django configure defaults helper class (3.12)
9 HOMEPAGE=               https://django-appconf.readthedocs.io/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/c0/98/1cb3d9e8b1c6d0a74539b998474796fc5c0c0888b6201e5c95ba2f7a0677
14 DISTFILE[1]=            django_appconf-1.0.6-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 DISTNAME=               django_appconf-1.0.6.dist-info
25
26 GENERATED=              yes
27
28 [PY311].RUN_DEPENDS_ON=                 python-Django:single:v11
29 [PY311].USES_ON=                        python:v11,wheel
30
31 [PY312].RUN_DEPENDS_ON=                 python-Django:single:v12
32 [PY312].USES_ON=                        python:v12,wheel
33
34 [FILE:2975:descriptions/desc.single]
35 django-appconf
36 ==============
37
38 A helper class for handling configuration defaults of packaged Django
39 apps gracefully.
40
41 .. note::
42
43     This app precedes Django's own AppConfig_ classes that act as
44     "objects [to] store metadata for an application" inside Django's
45     app loading mechanism. In other words, they solve a related but
46     different use case than django-appconf and can't easily be used
47     as a replacement. The similarity in name is purely coincidental.
48
49 .. _AppConfig:
50 https://docs.djangoproject.com/en/stable/ref/applications/#django.apps.AppConfig
51
52 Overview
53 --------
54
55 Say you have an app called myapp with a few defaults, which you want
56 to refer to in the app's code without repeating yourself all the time.
57 appconf provides a simple class to implement those defaults. Simply add
58 something like the following code somewhere in your app files:
59
60 .. code-block:: python
61
62     from appconf import AppConf
63
64     class MyAppConf(AppConf):
65         SETTING_1 = "one"
66         SETTING_2 = (
67             "two",
68         )
69
70 .. note::
71
72     AppConf classes depend on being imported during startup of the Django
73     process. Even though there are multiple modules loaded automatically,
74     only the models modules (usually the ``models.py`` file of your
75     app) are guaranteed to be loaded at startup. Therefore it's recommended
76     to put your AppConf subclass(es) there, too.
77
78 The settings are initialized with the capitalized app label of where the
79 setting is located at. E.g. if your ``models.py with the AppConf class
80 is in the myapp`` package, the prefix of the settings will be MYAPP.
81
82 You can override the default prefix by specifying a prefix attribute of
83 an inner Meta class:
84
85 .. code-block:: python
86
87     from appconf import AppConf
88
89     class AcmeAppConf(AppConf):
90         SETTING_1 = "one"
91         SETTING_2 = (
92             "two",
93         )
94
95         class Meta:
96             prefix = 'acme'
97
98 The MyAppConf class will automatically look at Django's global settings
99 to determine if you've overridden it. For example, adding this to your
100 site's
101 ``settings.py would override SETTING_1 of the above MyAppConf``:
102
103 .. code-block:: python
104
105     ACME_SETTING_1 = "uno"
106     
107 Since django-appconf completes Django's global settings with its default
108 values 
109 (like "one" above), the standard ``python manage.py diffsettings`` will
110 show 
111 these defaults automatically.
112
113 In case you want to use a different settings object instead of the default
114 ``'django.conf.settings'``, set the holder attribute of the inner
115 Meta class to a dotted import path:
116
117 .. code-block:: python
118
119     from appconf import AppConf
120
121     class MyAppConf(AppConf):
122         SETTING_1 = "one"
123         SETTING_2 = (
124             "two",
125         )
126
127         class Meta:
128             prefix = 'acme'
129             holder = 'acme.conf.settings'
130
131 If you ship an AppConf class with your reusable Django app, it's
132 recommended to put it in a ``conf.py file of your app package and
133 import django.conf.settings`` in it, too:
134
135
136
137 [FILE:116:distinfo]
138 c3ae442fba1ff7ec830412c5184b17169a7a1e71cf0864a4c3f93cf4c98a1993         6424 django_appconf-1.0.6-py3-none-any.whl
139