Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.75 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.75 KB
Raw

codecov Documentation Status

labthings-fastapi

A FastAPI based library to implement a Web of Things interface for laboratory hardware using Python. This is a ground-up rewrite of python-labthings, replacing Flask 1 and Marshmallow with FastAPI and Pydantic. It is the underlying framework for v3 of the OpenFlexure Microscope software.

Features include:

  • Better alignment with the Web of Things standard:
    • Extensions are gone, everything is now a Thing
    • Things are classes, with properties and actions defined exactly once
    • Various improvements to TD generation and validation with pydantic
  • Cleaner API
    • Datatypes of action input/outputs and properties are defined with Python type hints
    • Actions are defined exactly once, as a method of a Thing class
    • Properties and actions are declared using decorators (or descriptors if that's preferred)
    • Dependency injection is used to manage relationships between Things and dependency on the server
  • Async HTTP handling
    • Starlette (used by FastAPI) can handle requests asynchronously - potential for websockets/events (not used much yet)
    • Thing code is still, for now, threaded. I intend to make it possible to write async things in the future, but don't intend it to become mandatory
  • Smaller codebase
    • FastAPI more or less completely eliminates OpenAPI generation code from our codebase
    • Thing Description generation is very much simplified by the new structure (multiple Things instead of one massive Thing with many extensions)
  • Extensive testing
    • FastAPI/Starlette have nice test provision, so the vast majority of the codebase is already covered

Installation

You can install this repository with pip, either clone it and run pip install -e .[dev] to work on it, or just pip install https://gitlab.com/rwb27/labthings-fastapi.git. It will be published on PyPI in the near future, initially as labthings-fastapi. It may at some point be renamed to labthings v2.

Developer notes

The code is linted with ruff ., type checked with mypy src, and tested with pytest. These all run in CI with GitHub Actions. The codebase is not even v0.1 yet so it's still subject to summary rearrangement.

Demo

See the examples folder for a runnable demo.