Skip to main content

Hero landing page and endpoint catalog for Django APIs — wires docca's manifest into a ready-made portal with opt-in navbar fragments from billa and reggi.

Project description

romma

Hero landing page and endpoint catalog for Django APIs.

romma provides a ready-made hero landing page and a full endpoint catalog, wired directly to lxcor-docca's manifest. Navbar and footer fragments from lxcor-billa and lxcor-reggi are included via {% try_include %} — they render when those apps are installed and are silently skipped when they are not.

Part of the lxcor/api-suite.

Install

pip install lxcor-romma

Setup

# settings.py
INSTALLED_APPS = [
    ...
    'docca',  # required
    'romma',
]

TEMPLATES = [{
    ...
    'OPTIONS': {
        'context_processors': [
            ...
            'romma.context_processors.home_settings',
        ],
    },
}]
# urls.py
urlpatterns = [
    path('', include('romma.urls')),
]

Settings

Setting Default Description
SITE_NAME 'API' Displayed in the navbar brand and hero title
SITE_TAGLINE 'API' Browser <title> tagline
SITE_DESCRIPTION '' Hero subtitle paragraph
SITE_FREE_TIER_REQUESTS '' Free tier request count shown in the hero stats (e.g. '1,000')
DOCS_URL None URL for the "Documentation" button in the hero; hidden if None

What it renders

  • / — hero page with stats, per-app cards, and CTAs
  • /endpoints/ — full endpoint catalog with sidebar filter by app and tag
  • /robots.txt — auto-generated with sitemap reference

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lxcor_romma-0.1.2.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lxcor_romma-0.1.2-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file lxcor_romma-0.1.2.tar.gz.

File metadata

  • Download URL: lxcor_romma-0.1.2.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for lxcor_romma-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a998f200311ea85bb0d79e707045ee94d0d53ee3f3a8aa7da7f1cd159f30b4b9
MD5 bf062468ab444b06b90d078239b96626
BLAKE2b-256 c9a1a543deda520c339e090d659074ee5ebc78683148d71c461073fa1ec77a39

See more details on using hashes here.

File details

Details for the file lxcor_romma-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: lxcor_romma-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for lxcor_romma-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47bca582d8e0d46f0445d0add50ec86bb1707ff8626d66069149b9e828ece54b
MD5 80bf5c887ac889e6149476d34f445db2
BLAKE2b-256 eb899b5e3e99418f119ac622f5143d98ef97b464796c70eae88a2c688ce0c4cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page