Merge branch 'beta-release-prep' into 'master'
Readme, changelog, version bump See merge request openflexure/openflexure-microscope-server!136
This commit is contained in:
Richard Bowman
commit
76a807fba5
4 changed files with 42 additions and 6 deletions
|
|
@ -164,6 +164,7 @@ build:
|
|||
- "./openflexure_microscope/api/static/dist/"
|
||||
|
||||
only:
|
||||
- master
|
||||
- merge_requests
|
||||
- tags
|
||||
- web
|
||||
|
|
@ -198,6 +199,7 @@ package:
|
|||
- "./dist/openflexure-microscope-webapp-${CI_COMMIT_REF_NAME}.tar.gz.sha256"
|
||||
|
||||
only:
|
||||
- master
|
||||
- merge_requests
|
||||
- tags
|
||||
- web
|
||||
|
|
|
|||
19
CHANGELOG.md
19
CHANGELOG.md
|
|
@ -1,6 +1,19 @@
|
|||
# Unreleased
|
||||
* Added support for ImJoy
|
||||
* Added a setting to disable the gallery
|
||||
# [v2.10.0b2](https://gitlab.com/openflexure/openflexure-microscope-server/compare/v2.10.0b1...v2.10.0b2) (2021-08-11)
|
||||
## New features
|
||||
* Added support for ImJoy plugins ([!120](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/120))
|
||||
* Added a setting to disable the gallery ([!120](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/120))
|
||||
* Scan parameters are now remembered in the "capture" pane ([!132](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/132))
|
||||
* The Capture pane now contains controls for the smart stack plugin, if installed (([!134](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/134)))
|
||||
|
||||
## Developer changes
|
||||
* CI now fails if `Pipfile.lock` is out of date ([!131](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/131))
|
||||
* The Thing Description and OpenAPI documentation are now valid, and much improved ([!133](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/133))
|
||||
* Pytest XML reports are now recorded in the CI pipeline ([!135](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/135))
|
||||
* The application is now packaged for every commit on `master` ([!136](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/136))
|
||||
|
||||
# [v2.10.0b0](https://gitlab.com/openflexure/openflexure-microscope-server/compare/v2.10.0b0...v2.10.0b1) (2021-05-26)
|
||||
## Minor bug fixes and improvements
|
||||
* Fixed some installation issues with updated Python dependencies ([!129](https://gitlab.com/openflexure/openflexure-microscope-server/-/merge_requests/129))
|
||||
|
||||
# [v2.10.0b0](https://gitlab.com/openflexure/openflexure-microscope-server/compare/v2.9.3...v2.10.0b0) (2021-05-18)
|
||||
|
||||
|
|
|
|||
25
README.md
25
README.md
|
|
@ -28,7 +28,28 @@ There are 2 important settings files, described in the [docs](https://openflexur
|
|||
|
||||
# Developer guidelines
|
||||
|
||||
## Local installation
|
||||
## Developing on a Raspberry Pi
|
||||
|
||||
The easiest way to work on the software is to build an OpenFlexure Microscope around a Raspberry Pi, using our custom disk image. This includes a pre-installed copy of this server, and a pre-built copy of the web application, so it's ready to use. You can also develop directly on the Raspberry Pi, and this is the best way to test out changes to the Python code using actual hardware. To do this, use the command-line script `ofm develop`. This will replace the server application at `/var/openflexure/application/openflexure-microscope-server/` with a clone of this git repository. You can manage the server with the `ofm` command, using `ofm start`, `ofm stop`, and `ofm restart` to do the respective actions. `ofm serve` will run a debug server that prints its logs and errors to the console.
|
||||
|
||||
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 `ofm develop` uses an `https://` address for the git repository, 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.
|
||||
|
||||
### Updating just the web app
|
||||
|
||||
Installing and running node.js on a Raspberry Pi is slow and often frustrating. Our preference is to do node.js development on another computer, and connect either to a dummy server on that computer, or to a real microscope elsewhere on the network. If you only want to work on the Python code, it's possible to download a pre-built web application and use it with your modified Python code. To do this, locate the archive of the web application, and then run:
|
||||
```
|
||||
cd /var/openflexure/
|
||||
sudo chown -R openflexure-ws.openflexure-ws .
|
||||
sudo chmod -R g+w .
|
||||
cd application/openflexure-microscope-server/
|
||||
sudo rm -rf openflexure_microscope/api/static/dist/
|
||||
curl <tarball URL> | tar -xz
|
||||
```
|
||||
NB the `sudo chown` and `sudo chmod` lines are probably unnecessary, but depending on the state of your system they may fix annoying permissions issues.
|
||||
|
||||
To find the `<tarball URL>` you should look for `openflexure-microscope-webapp-<version>.tar.gz` on the [build server](https://build.openflexure.org/openflexure-microscope-server/), or open the `package` job of a CI pipeline on this repository, and locate it by browsing the artifacts. That should work for any merge request that's currently open.
|
||||
|
||||
## Installation on other platforms
|
||||
|
||||
The Raspberry Pi image we use currently ships with Python 3.7.3. For local development on a different platform, please use PyEnv or similar to make sure you're running on this version. For example, Windows users can use [Scoop](https://scoop.sh/) to install specific Python versions. This repository contains two closely related parts; a web server written in Python, that handles hardware control, and a web application using Vue.js that provides a graphical control interface. It is possible to work on either of these in isolation, but bear in mind that if you only set up Python development, you will need to host the web application elsewhere.
|
||||
|
||||
|
|
@ -139,7 +160,7 @@ As of `2.10.0b0` we have switched to using `pipenv` for managing dependencies, a
|
|||
## Changelog generation
|
||||
|
||||
* `npm install -g conventional-changelog-cli`
|
||||
* `conventional-changelog -r 1 --config ./changelog.config.js -i CHANGELOG.md -s`
|
||||
* `npx conventional-changelog -r 1 --config ./changelog.config.js -i CHANGELOG.md -s`
|
||||
|
||||
## Microscope extensions
|
||||
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -22,7 +22,7 @@ with open(path.join(here, "README.md"), encoding="utf-8") as f:
|
|||
|
||||
setup(
|
||||
name="openflexure-microscope-server",
|
||||
version="2.10.0b1",
|
||||
version="2.10.0b2",
|
||||
description="Python module, and Flask-based web API, to run the OpenFlexure Microscope.",
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/markdown",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue