Codi Cooperatiu internal tools
Project description
codi-cooperatiu-internal-tools
Eines i mòduls interns de Codi Cooperatiu
flowbite_css
flowbite_css
aplica personalitzacions de formulari automàticament. Aquesta personalització fa servir estils de Flowbite, una personalització de Tailwind.
Configuració
Per fer servir aquestes personalitzacions, hem d'afegir l'aplicació flowbite_css
al paràmetre INSTALLED_APPS
del fitxer settings.py
.
CODI_COOP_ENABLE_MONKEY_PATCH
El paràmetre CODI_COOP_ENABLE_MONKEY_PATCH
en el fitxer settings.py
controla si s'ha d'aplicar o no un monkey patch als camps de formulari de Django dins la vostra aplicació.
Per defecte, el paràmetre CODI_COOP_ENABLE_MONKEY_PATCH
està desactivat (False
). Això significa que el monkey patch no s'aplicarà. Si voleu activar el monkey patch, heu d'afegir el paràmetre CODI_COOP_ENABLE_MONKEY_PATCH
al fitxer settings.py
i establir-lo a True
.
Exemples:
Activar el monkey patching:
# settings.py
CODI_COOP_ENABLE_MONKEY_PATCH = True
Quan aquest paràmetre està activat (True
), els camps de formulari de Django com CharField
, EmailField
, IntegerField
, ChoiceField
, MultipleChoiceField
, i BooleanField
utilitzaran els camps personalitzats definits en la vostra aplicació (CharBoundField
, BooleanBoundField
, etc.), permetent un estil i comportament personalitzats en els vostres formularis.
Desactivar el monkey patching:
# settings.py
CODI_COOP_ENABLE_MONKEY_PATCH = False # Valor per defecte
Si aquest paràmetre està desactivat (False), els camps de formulari de Django funcionaran amb el seu comportament i estil per defecte, sense cap personalització addicional.
FORM_RENDERER
També tenim la possibilitat de fer servir la plantilla personalitzada que mostra tot el HTML vinculat amb els camps (<label />
i qualsevol altre HTML) amb classes de Flowbite.
En aquest cas, hauríem de fer servir el form render CustomFormRenderer
configurant-ho al fitxer settings.py
amb el parametre FORM_RENDERER
:
# settings.py
FORM_RENDERER = "flowbite_css.renderers.CustomFormRenderer"
Contribució
Instal·la els requisits
Instal·la les dependències per al desenvolupament anant a la carpeta «codi-cooperatiu-internal-tools» i després s'executa:
pip install -r requirements.txt
A més d'aquests requisits també hauràs d'instal·lar el propi Django. Per a instal·lar la versió actual de Django:
pip install django
El codi ve amb git hook scripts. Aquests es poden instal·lar executant-se:
pre-commit install
El pre-commit ara s'executarà automàticament al fer git-commit i comprovarà l'adhesió a la guia d'estil (black, isort i flake8).
Executa les proves
Abans d'enviar una pull request, executeu tot el conjunt de proves «codi-cooperatiu-internal-tools» via:
make test
Si no teniu instal·lat el make
, el conjunt de proves també es pot executar via:
pytest --ds=tests.test_settings --cov=flowbite_classes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for codi_cooperatiu_internal_tools-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3587b627e0213354df3dea7373915b51dcc7f4194359729ae32be368bcf3edc0 |
|
MD5 | caf909d028e0e923749f389a3224ab84 |
|
BLAKE2b-256 | eb76c69133770e46a5f9d648d1839578c31fe832894567e3633f3860781fa01d |
Hashes for codi_cooperatiu_internal_tools-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3fe3025088f20f3821e39dd382822e829d24910a9c62242cd3830d237366d94 |
|
MD5 | 6adc2b7db1cf830947cfb15d3fbf390b |
|
BLAKE2b-256 | f2a897dfbb751ad3fd530d3a82a1b05e0b3703d7531843417533369202afafac |