Reticulum_OpenAPI

KO | EN

gitlite — search

#hacktoberfest #typescript #go #golang #machine-learning #docker #macos #java #awesome #cli #vue #awesome-list #openai #open-source

Reticulum_OpenAPI

(★ 12)

he Reticulum LXMF-based API system aims to offer a secure, portable, and efficient API layer on top of a resilient mesh network

Reticulum_OpenAPI 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Reticulum OpenAPI

[![Python](https://github.com/FreeTAKTeam/Reticulum_OpenAPI/actions/workflows/python.yml/badge.svg?branch=main)](https://github.com/FreeTAKTeam/Reticulum_OpenAPI/actions/workflows/python.yml)

Reticulum OpenAPI is an experimental framework for building lightweight APIs on top of the Reticulum mesh network using LXMF messages. It allows you to expose simple command based or REST style services that work in delay tolerant and very low bandwidth environments. Payloads are encoded with canonical MessagePack by default with JSON as a fallback for interoperability.

This repository contains the Python implementation of the framework as well as documentation, a full featured example and generator templates. The goal is to provide an easy way to build applications that communicate over Reticulum using structured messages.

Models and payloads are serialized with MessagePack to minimize bandwidth overhead.

The project now also exposes primitives for maintaining persistent links via
``LinkClient`` and ``LinkService`` which allow direct communication over an
``RNS.Link`` in addition to LXMF messaging.

See [docs/protocol_design.md](docs/protocol_design.md) for the protocol overview and [docs/Framework_design.md](docs/Framework_design.md) for architectural details.

## Communication Modes

The framework can operate in two different modes depending on the type of
interaction required:

- **LXMF messages** – Asynchronous store‑and‑forward messaging. Each request
  and response fits in a single LXMF envelope, making it ideal for low bandwidth
  or intermittently connected links.
- **Link sessions** – A real‑time `RNS.Link` between peers. Links provide lower
  latency and support streaming data or large transfers at the cost of keeping a
  connection alive.

Use LXMF for command/response APIs and situations where delivery may be delayed.
Choose Link mode when you need interactive exchanges or to move large resources
efficiently.

## Resource transfers

The package also includes helpers for sending and receiving larger files over Reticulum links. Use
`ResourceClient.send_resource()` to upload a file with progress reporting and
`ResourceService.resource_received_callback()` to store incoming resources in a chosen directory.

## Quick start

Install dependencies (requires Python 3.8+):

```bash
pip install -r requirements.txt
```

The requirements file now pins Reticulum (RNS) 1.0.2 and LXMF 0.9.2 so the framework installs the latest stable mesh networking stack by default.

### Running the example server

The Emergency Management example exposes both a Reticulum‑backed service and an HTTP
gateway implemented with FastAPI. Start the Reticulum service first:

```bash
python examples/EmergencyManagement/Server/server_emergency.py \
  --config-path ~/.reticulum \
  --storage-path ~/.reticulum/lxmf \
  --display-name "Emergency Ops" \
  --auth-token YOUR_TOKEN \
  --link-keepalive-interval 30 \
  --database-path ./emergency.db
```

All flags are optional; omit them to fall back to the defaults embedded in the
example. At startup the server prints the announced identity hash, command
destination hash, and the active configuration so that clients can copy the
values without digging through the code.

### Starting the HTTP gateway

Launch the FastAPI gateway with `uvicorn` to serve the OpenAPI on
`http://localhost:8000`:

```bash
uvicorn examples.EmergencyManagement.web_gateway.app:app --host 0.0.0.0 --port 8000 --reload
```

Once the server starts you should see a log message similar to `Uvicorn running on
http://0.0.0.0:8000`. Visit `http://localhost:8000/docs` for the interactive API docs
or `http://localhost:8000/` to confirm the health status payload.

### Running the example client

```bash
python examples/EmergencyManagement/client/client_emergency.py
```

The client will ask for the server identity hash which the server prints on startup.

## Development

Before running tests or any of the example programs, make sure the project
dependencies are installed:

```bash
pip install -r requirements.txt
```

Tests can then be run with `pytest` and code style is checked with `flake8`.

## Release workflow

Follow these steps to build and publish a new release from the `main` branch:

1. Bump the version in `pyproject.toml` and update any relevant documentation or
   changelog entries.
2. Install the packaging utilities inside your virtual environment:

```bash
   python -m pip install build twine
   ```

The `build` module is not part of the standard library, so installing it
   beforehand prevents `python -m build` from failing with `No module named build`.
3. Regenerate the distribution artifacts:

```bash
   python -m build
   ```

4. Optionally validate the artifacts before uploading them to PyPI:

```bash
   python -m twine check dist/*
   ```

5. Tag the release (`git tag -a vX.Y.Z -m "Release vX.Y.Z"`), push the tag, and
   draft the corresponding GitHub release with the generated artifacts and notes.

## Further resources

- [examples/EmergencyManagement/README.md](examples/EmergencyManagement/README.md) – walkthrough of the sample API implementation.
- [templates/README.md](templates/README.md) – using the generator templates to scaffold a service.
- [docs/Framework_design.md](docs/Framework_design.md) – in-depth description of the architecture.
- [docs/protocol_design.md](docs/protocol_design.md) – detailed protocol design discussion.

Reticulum_OpenAPI

Reticulum_OpenAPI 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Reticulum_OpenAPI

Reticulum_OpenAPI 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README