Metadata-Version: 2.4
Name: fastcc
Version: 2026.5.6
Summary: Lightweight, efficient and developer-friendly framework for MQTT communication.
Author-email: "J. Baudisch" <justin.baudisch@hsbi.de>
Maintainer-email: "J. Baudisch" <justin.baudisch@hsbi.de>
License-Expression: MIT
Project-URL: Repository, https://github.com/ReMi-HSBI/fastcc
Project-URL: Issues, https://github.com/ReMi-HSBI/fastcc/issues
Keywords: mqtt,iot,aiomqtt,asyncio
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Communications
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiomqtt
Requires-Dist: protobuf
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: types-protobuf; extra == "dev"
Dynamic: license-file

[![ruff](https://img.shields.io/badge/ruff-⚡-261230.svg?style=flat-square)](https://github.com/astral-sh/ruff)
[![mypy](https://img.shields.io/badge/mypy-📝-2a6db2.svg?style=flat-square)](https://github.com/python/mypy)
[![gitmoji](https://img.shields.io/badge/gitmoji-😜%20😍-FFDD67.svg?style=flat-square)](https://github.com/carloscuesta/gitmoji)

<p align="center">
    <img
        src="https://github.com/ReMi-HSBI/fastcc/blob/main/docs/src/static/images/logos/fastcc.svg?raw=true"
        alt="FastCC Logo"
        width="33%"
    />
</p>

# FastCC

FastCC is a lightweight, efficient and developer-friendly framework for
[MQTT](https://mqtt.org) communication written in
[Python](https://www.python.org). It is built on top of the
[aiomqtt](https://github.com/empicano/aiomqtt) library and extends it
with the following functionalities:

| Feature                          | Status          |
| -------------------------------- | --------------- |
| Request/Response                 | ✅ Done         |
| Streaming                        | ✅ Done         |
| Routing                          | ✅ Done         |
| Custom encoding/decoding         | ✅ Done         |

## Miscellaneous

### API Documentation

To build the API Documentation, use the following command in the
root-directory of the project.

`sphinx-build -M html docs/src docs/build`

> Ensure that your virtual environment is activated and that the
> development extras are installed, as they include the docstring
> tooling required to build the API documentation.

### Code Style

To enforce a consistent code style, this project uses
[ruff](https://github.com/astral-sh/ruff) and [mypy](https://github.com/python/mypy).

### Commit Message

To ensure consistent and expressive commit messages, this project uses
[gitmoji](https://github.com/carloscuesta/gitmoji) combined in a
`git-commit` skill for generative AI.
