rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README to point at CONTRIBUTING and make contributing link to site, then give repository specifics.

Browse source
This commit is contained in:
Julian Stirling 2025-07-11 12:35:39 +01:00
parent 31ed7dfc69
commit 7b5ce1d165
2 changed files with 29 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

100
CONTRIBUTING.md
View file

@ -1,94 +1,44 @@
# Contributing # Contributing to the OpenFlexure Microscope Server
When contributing to this repository, please first discuss the change you wish to make via issue, All contributions to the OpenFlexure project should follow our [project contributions guidelines](https://openflexure.org/contribute).
email, or any other method with the owners of this repository before making a change.
Please note we have a working flow, and a code of conduct. Please follow it in all your interactions with the project. Any contributions to this repository should follow [our code of conduct](https://openflexure.org/conduct).
## Flow If you are interested in contributing to the OpenFlexure project and do not know where to start we recommend you visit [our forum](https://openflexure.discourse.group/).
<img src="https://gitlab.com/openflexure/openflexure-identity/raw/master/flow.png" height="200">
### Development **The rest of this page details contribution guidelines that are specific to this repository.**
* Master is the latest working version. This page generally focusses on the the server not the front-end webapp. For more details on the webapp development see the [webapp's README](./webapp/README.md).
* New features and bug fixes should be developed on branches (or forks), and merged into master.
### Releases ## Python Development
* Once we've merged a few things in and want to make a release, we tag it on master. For installation see the [project README](./README.md).
* Not every commit on master will get a tag, we'll accumulate a few changes before making a release, unless there's a reason to release straight away.
* Once we're confident that the tagged release is building and stable, we merge it into the stable branch.
* As and when 2.x.x appears, we will move 1.x.x to a branch in case we want to push out bugfixes, but we're not likely to do this for minor releases.
## Code of Conduct ### Core packages and concepts
In the interest of fostering an open and welcoming environment, we as The OpenFlexure Microscope server is built in the [LabThings-FastAPI framework](https://labthings-fastapi.readthedocs.io/en/latest/). This provides a convenient way to expose laboratory hardware over HTTP via a [FastAPI server](https://fastapi.tiangolo.com/).
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
### Our Standards The core elements of the server code are `Things`. A `Thing` creates a [W3C Web of Things](https://www.w3.org/TR/wot-architecture) compliant HTTP interface for hardware interactions and other server functionality.
Examples of behavior that contributes to creating a positive environment The project also makes use of the following libraries:
include:
* Using welcoming and inclusive language * [Pydantic](https://docs.pydantic.dev/latest/) - For serialising/deserialising data being saved to disk or sent over HTTP.
* Being respectful of differing viewpoints and experiences * [OpenFlexure Stitching](https://gitlab.com/openflexure/openflexure-stitching) - Our own library for creating composite microscope images from a scan.
* Gracefully accepting constructive criticism * [OpenCV](https://opencv.org/) and [Picamera2](https://github.com/raspberrypi/picamera2/) - For controlling cameras, and simulating cameras for tests.
* Focusing on what is best for the community * [Pillow](https://pillow.readthedocs.io) - For image manipulation and saving.
* Showing empathy towards other community members * [NumPy](https://numpy.org/) and [SciPy](https://scipy.org/) - For mathematical calculations.
Examples of unacceptable behavior by participants include: *The list above is not exhaustive!*
* The use of sexualized language or imagery and unwelcome sexual attention or ## Programming style
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
### Our Responsibilities Ideally python code should be:
Project maintainers are responsible for clarifying the standards of acceptable * Broken up into small clear testable functions.
behavior and are expected to take appropriate and fair corrective action in * Documented with docstrings (For conventions see below).
response to any instances of unacceptable behavior. * Type hinted
* Covered by unit tests
Project maintainers have the right and responsibility to remove, edit, or The server code is going through significant flux during the transition from v2 to v3, so currently our test coverage is being rebuilt and type checking does not yet pass.
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
### Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
### Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

6
README.md
View file

@ -49,7 +49,7 @@ You can manage the server with the `ofm` command, using `ofm start`, `ofm stop`,
ofm stop ofm stop
ofm activate ofm activate
cd /var/openflexure cd /var/openflexure
sudo -u openflexure-ws openflexure-microscope-server -c microscope_configuration.json --host 0.0.0.0 --port 5000 sudo -u openflexure-ws openflexure-microscope-server --fallback -c microscope_configuration.json --host 0.0.0.0 --port 5000
``` ```
Our favourite way of working with the server on a Pi is to follow the instructions above, then open a VSCode Remote session from another computer. This allows you to use your usual developer environment to write code, but everything runs on the Raspberry Pi with real hardware. Note that the repository is cloned by default over `https`, so you will probably need to change the "remote" URL to your fork of the repository, or to SSH, before you're able to push changes. Our favourite way of working with the server on a Pi is to follow the instructions above, then open a VSCode Remote session from another computer. This allows you to use your usual developer environment to write code, but everything runs on the Raspberry Pi with real hardware. Note that the repository is cloned by default over `https`, so you will probably need to change the "remote" URL to your fork of the repository, or to SSH, before you're able to push changes.
@ -103,7 +103,8 @@ The Labthings-FastAPI server, written in Python, serves a web application writte
For more details on the web app see the ReadMe in the [webapp](./webapp) directory. For more details on the web app see the ReadMe in the [webapp](./webapp) directory.
## Formatting, linting, and tests ## Python: Formatting, linting, and tests
All of the commands below assume that you are running in the OFM virtual environment, i.e. you have run `ofm activate` on an OpenFlexure SD card, or `source .venv/bin/activate` on Linux, or `.venv/Scripts/activate`on Windows. All of the commands below assume that you are running in the OFM virtual environment, i.e. you have run `ofm activate` on an OpenFlexure SD card, or `source .venv/bin/activate` on Linux, or `.venv/Scripts/activate`on Windows.
**Before committing** you should lint and auto-format your code: **Before committing** you should lint and auto-format your code:
@ -120,6 +121,7 @@ All of the commands below assume that you are running in the OFM virtual environ
* `mypy src` (currently fails) * `mypy src` (currently fails)
* `pytest` * `pytest`
For more details on out Python conventions please see the **[project contributions guide](./CONTRIBUTING.md)**.
### Details ### Details