Skip to main content

📦 Enap Design System - Módulo para Wagtail

Este é um módulo customizado para o Wagtail, criado para facilitar a implementação de layouts e componentes reutilizáveis no CMS.

🛫 Outros READMEs

README.md, doc geral do projeto README.md README-use.md, doc do uso do módulo README-use.md [ATUAL] README-pypi.md, doc subir pacote pypi README-pypi.md

ENAP Design System

O ENAP Design System é um módulo para o Wagtail, baseado no CodeRedCMS, que fornece componentes reutilizáveis e templates pré-configurados para facilitar a criação de sites institucionais.

Instalação

Para instalar o pacote via PyPI, utilize:

pip install wagtail-enap-designsystem

Requisitos

  • Wagtail 6.4+
  • CodeRedCMS 4.1.1+
  • Django 4+

Configuração

Após a instalação, adicione enap_designsystem ao seu INSTALLED_APPS no settings.py:

INSTALLED_APPS = [
    "enap_designsystem",
    "coderedcms",  # Certifique-se de que o CodeRedCMS está instalado

    # ... outros módulos, como por exemplo: ...
    "wagtail.contrib.forms",
    "wagtail.contrib.redirects",
    "wagtail.embeds",
    "wagtail.sites",
    "wagtail.users",
    "wagtail.snippets",
    "wagtail.documents",
    "wagtail.images",
    "wagtail.search",
    "wagtail.admin",
    "wagtail",
    "taggit",
    "modelcluster",
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
]

Executando Migrações

Após a instalação e configuração, rode as migrações para garantir que todas as tabelas necessárias sejam criadas:

python manage.py migrate

Uso

O enap_designsystem adiciona os seguintes recursos ao seu projeto:

  • ENAPLayout: Página base herdando de CoderedWebPage, com suporte a anotações.
  • RootPage: Página raiz configurada para permitir apenas subpáginas do tipo ENAPLayout.
  • Componentes Wagtail: Blocos personalizados para layouts institucionais.
  • Templates Pré-preenchidos: Modelos prontos para diferentes tipos de páginas.

Criando uma Página com ENAPLayout

No painel administrativo do Wagtail, ao criar uma nova página, selecione ENAPLayout para utilizar os templates e funcionalidades do módulo.

Cache

Se estiver utilizando wagtailcache, certifique-se de configurar corretamente o cache, pois a função cache_clear ainda não tem suporte completo:

WAGTAIL_CACHE_BACKEND = "default"

Desenvolvimento

(OPCIONAL dev) Se estiver contribuindo para o desenvolvimento do módulo, clone o repositório e instale no modo editable:

git clone https://github.com/seu-org/enap_designsystem.git
cd enap_designsystem
pip install -e .

Para rodar o ambiente de desenvolvimento:

python manage.py runserver

Contribuindo

Pull requests são bem-vindos! Para sugestões e melhorias, abra uma issue no repositório oficial.


🏛️ Desenvolvido por ENAP

Metadata

Release files for wagtail-enap-designsystem 1.2.1.360

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtail-enap-designsystem 1.2.1.360
File Size Uploaded
wagtail_enap_designsystem-1.2.1.360.tar.gz 98.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-enap-designsystem 1.2.1.360
File Interpreter ABI Platform
wagtail_enap_designsystem-1.2.1.360-py3-none-any.whl Python 3 none any Details

Total release size: 202.1 MB

Release files / wagtail_enap_designsystem-1.2.1.360.tar.gz

Download URL wagtail_enap_designsystem-1.2.1.360.tar.gz
Size 98.6 MB
Tags Source
SHA-256 checksum
How to use checksums
e7bbc7c3ada46faf914456687dd0389ec2c590fa0aeb7930fe51a171ef1045c1
BLAKE2b-256 checksum
How to use checksums
aac55e40c32579f76e1b89a00e31510b4203710e51bd8139541b85c7cd05d7b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / wagtail_enap_designsystem-1.2.1.360-py3-none-any.whl

Download URL wagtail_enap_designsystem-1.2.1.360-py3-none-any.whl
Size 103.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b2a5a8e0d7588715f28a67d984493af43c33a7182dcb0de50c5144ef3eb0fab6
BLAKE2b-256 checksum
How to use checksums
0dcbac09525591919bdf551167de563c706f22006bd907c5123fb9fbdd126eb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

1.2.1.360 This release

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page