semvec/pypi-packages huggingface dataset:
cross-docs 0.14.0
Documentation framework built on Cross-Inertia
License: MIT
Requires Python: >=3.10
Keywords: documentation, fastapi, inertia, react, ssr

# cross-docs

Python backend utilities for Cross-Docs documentation framework.

## Installation

```bash
uv add cross-docs
# or
pip install cross-docs
```

## Usage

```python
from pathlib import Path
from fastapi import FastAPI, Request
from cross_docs import (
    generate_nav,
    create_docs_handler,
    strip_trailing_slash_middleware,
)
from cross_inertia.fastapi import InertiaDep

app = FastAPI()
app.middleware("http")(strip_trailing_slash_middleware)

CONTENT_DIR = Path("content")
NAV = generate_nav(CONTENT_DIR / "docs")

docs_handler = create_docs_handler(CONTENT_DIR, NAV)

@app.get("/docs")
async def docs_index(request: Request, inertia: InertiaDep):
    return await docs_handler(request, inertia)

@app.get("/docs/{path:path}")
async def docs_page(path: str, request: Request, inertia: InertiaDep):
    return await docs_handler(request, inertia, path=path)
```

## API

### Markdown Utilities

- `parse_frontmatter(content: str)` - Parse YAML frontmatter
- `load_markdown(content_dir: Path, path: str)` - Load and parse markdown
- `load_raw_markdown(content_dir: Path, path: str)` - Load raw markdown

### Navigation

- `generate_nav(docs_dir, base_path, section_order, index_page)` - Generate nav from files

### Middleware

- `strip_trailing_slash_middleware` - Redirect trailing slashes
- `wants_markdown(request)` - Check Accept header for markdown

### Routes

- `create_docs_handler(...)` - Create a docs route handler

## License

MIT
specklia 1.9.122
Python client for Specklia, a geospatial point cloud database by Earthwave.
License: MIT
Requires Python: >=3.11

# Specklia

Specklia is a cloud-hosted geospatial point cloud database designed for satellite altimetry data, produced by [Earthwave Ltd](https://earthwave.co.uk/). This package is the open-source Python Client for Specklia. It is intended for use by Academics within automated workflows and Jupyter Notebooks. Note that in order to use Specklia, you must first [generate an API key](https://specklia.earthwave.co.uk).

When using Earth Observation data, Academics are often presented with deeply nested folder structures containing headers that need to be manually parsed and files that contain large quantites of data not relevant to the current study. Specklia solves this problem by allowing users to request only the data within their desired study region, time period, and other filter criteria, and have it delivered right into their python workspace as a GeoDataFrame, without losing any of the headers and traceability information that standard product files provide.

Specklia was produced using funding from the [European Space Agency](https://www.esa.int/), and originally designed to host the [Cryo-TEMPO EOLIS Products](https://cryotempo-eolis.org/), which are derived from [CryoSat-2](https://www.esa.int/Applications/Observing_the_Earth/FutureEO/CryoSat) data. More information can be found at [Specklia's home page](https://specklia.earthwave.co.uk/).

If you're interested in influencing Specklia's development, using it in ways that are not
immediately enabled by the python client, or you have other support queries, please contact [support@earthwave.co.uk](mailto:support@earthwave.co.uk).