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.0.tar.gz (7.3 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.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lxcor_romma-0.1.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for lxcor_romma-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eca0568f19b1bbf09d70ee4d2effd6be0449be9447f6c08b55250e29e5e9a141
MD5 ee4aee686e7ba150f960e004cf253da1
BLAKE2b-256 05b04d465cdabc2ec3066348daaec15c4a2011c91c51ae686fc31e8f0b1883d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lxcor_romma-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for lxcor_romma-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be8402fbb7859e894141d6de11592ad61c1a5032cf056d7f26d63eed9ba8c9a7
MD5 eec63143d0236eae6ceef4110b1fcaba
BLAKE2b-256 863eb8d7652d9c1f3c89889b57c43f2e6a2c7309ebf4fbf796aaa9b9c42be27c

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