Skip to content

Commit 859f441

Browse files
committed
Delete examples
We may want to remove the folder entirely. The counter is moved into the tutorial, and the demo thing server was horrible anyway. The `MyThing` class exists in the module as an example thing, but should probably be split up and most of it moved into unit tests. In short, this deletion doesn't remove anything that isn't provided in a more useful form elsewhere.
1 parent 85efab5 commit 859f441

3 files changed

Lines changed: 2 additions & 165 deletions

File tree

examples/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# LabThings-FastAPI Examples
22

3-
The files in this folder are example code that was used in development and may be helpful to users. It's not currently tested, so there are no guarantees as to how current each example is. Some of them have been moved into `/tests/` and those ones do get checked: at some point in the future a combined documentation/testing system might usefully deduplicate this.
3+
This folder used to contain some example python scripts, however these were not tested and were going stale. For a simple example, please see the tutorial section of [readthedocs].
44

5-
Two camera-related examples have been removed, there are better `Thing`s already written for handling cameras as part of the [OpenFlexure Microscope] and you can find the relevant [camera Thing code] there.
6-
7-
To run these examples, it's best to look at the tutorial or quickstart guides on our [readthedocs] site.
5+
For some more complicated `Thing`s already written for handling cameras, see the [OpenFlexure Microscope] - you can find the relevant [camera Thing code] there.
86

97
[readthedocs]: https://labthings-fastapi.readthedocs.io/
108
[OpenFlexure Microscope]: https://openflexure.org/

examples/counter.py

Lines changed: 0 additions & 32 deletions
This file was deleted.

examples/demo_thing_server.py

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)