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
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 Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lxcor_romma-0.1.1-py3-none-any.whl.
File metadata
- Download URL: lxcor_romma-0.1.1-py3-none-any.whl
- Upload date:
- Size: 11.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a61bd7ba9e0b4e5ad204d91cf50fa3f2e204cb12045ea214528808ceef37668
|
|
| MD5 |
5d0981a978e9262e055b8dad02c57347
|
|
| BLAKE2b-256 |
7d6a4406783783de6ecb57560164f5153a30558439ecd074cea94dd272dbd2c8
|