README.md
Rama main · réplica de lectura del repositorio original.
[](https://opensource.org/licenses/MIT)
[](https://github.com/datannur/datannur/releases)
[](https://github.com/datannur/datannur/actions/workflows/ci.yml)
[](https://github.com/datannur/datannur/actions/workflows/deploy-pages.yml)
[](https://dev.datannur.com/)
# datannur
datannur is an open-source data catalog that runs from static files, without requiring a server or database. This repository contains the datannur app; for most users, the easiest way to create a catalog from real files or databases is the Python builder, [`datannurpy`](https://github.com/datannur/datannurpy). To publish a catalog on GitHub Pages without installing anything, start from the [`datannur-template`](https://github.com/datannur/datannur-template).
👉 [Try the live demo](https://dev.datannur.com/) · [Read the docs](https://docs.datannur.com/app/) · [Use the Python builder](https://github.com/datannur/datannurpy) · [Publish with the template](https://github.com/datannur/datannur-template)
## Supported data sources
datannur can catalog structured data from:
- **Tabular and statistical files:** CSV, Excel, ODS, Parquet, Delta Lake, Apache Iceberg, SAS, SPSS, Stata
- **Geospatial data:** GeoJSON, Shapefile, GeoPackage, GeoParquet, GeoTIFF, GML, KML, GPX, ESRI File Geodatabase
- **Relational databases:** PostgreSQL, MySQL, Oracle, SQL Server, SQLite, DuckDB
See the [builder documentation](https://docs.datannur.com/builder/) for details, including remote and cloud data sources.
## Why datannur?
Useful datasets are often scattered across spreadsheets, databases, folders, definitions, and documentation. datannur helps make this metadata visible, understandable, and shareable while keeping the catalog lightweight, portable, and under your control.
Start small or scale gradually: generate a portable catalog, explore it in the browser, and share it from a local folder, shared drive, web server, or cloud storage.
## Quick start: publish a catalog on GitHub Pages
The [datannur-template](https://github.com/datannur/datannur-template) publishes your own catalog on GitHub Pages in a few minutes, without a server or local install: click **Use this template**, point `catalog.yml` at open data URLs or drop files in `datasets/`, and every commit rebuilds the catalog automatically. See the [live example](https://datannur.github.io/datannur-template/).
Everything in a public repository is public, including the data files. For internal or sensitive data, build the catalog locally with `datannurpy` instead.
## Quick start: build a catalog locally with datannurpy
```bash
pip install datannurpy
```
Create a `catalog.yml`:
```yaml
# catalog.yml
app_path: ./my-catalog
open_browser: true
add:
- folder: ./data
include: ['*.csv', '*.xlsx', '*.parquet']
- database: sqlite:///mydb.sqlite
```
Build and open the catalog:
```bash
python -m datannurpy catalog.yml
```
See the [datannurpy repository](https://github.com/datannur/datannurpy) and the [builder documentation](https://docs.datannur.com/builder/) for more input sources, including databases, cloud storage, and the Python API.
## This repository
The datannur app is the portable catalog interface that runs from a single `index.html`. It is bundled by `datannurpy` when you create a catalog, and this repository is the right place to develop the UI, inspect the app source, or explore the demo data.
**Key features:**
- **Zero-config deployment** - Runs from a single `index.html`
- **Portable** - Works locally, on shared drives, or cloud storage
- **Structured metadata** - Organizes catalogs around 8 core concepts: Organization, Folder, Tag, Concept, Doc, Dataset, Variable, and Enumeration
- **Browser-isolated** - Runs in the browser sandbox, with no direct system access
- **Multilingual interface** - English by default, with French, German, and Italian support and browser language detection
## Documentation
🧰 **Builder:** [github.com/datannur/datannurpy](https://github.com/datannur/datannurpy)
📦 **Template:** [github.com/datannur/datannur-template](https://github.com/datannur/datannur-template)
🚀 **Demo:** [dev.datannur.com](https://dev.datannur.com/)
📖 **Full documentation:** [docs.datannur.com/app](https://docs.datannur.com/app/)
🌐 **Website:** [datannur.com](https://datannur.com)
## Contributing
For development documentation and contributing guidelines, see [`CONTRIBUTING.md`](https://github.com/datannur/datannur?tab=contributing-ov-file).
## License
MIT - see [LICENSE](LICENSE). All dependencies are MIT/Apache 2.0/BSD compatible.