Commit ed3c82a5 authored by Joel Collins's avatar Joel Collins
Browse files

Updated dev readme

parent 92669e06

README.md

+2 −2
Original line number Diff line number Diff line
@@ -13,13 +13,13 @@ This module is currently in very early development, and is perhaps best installe 
# Developer usage examples

## Running the web API in Gunicorn (port 5000)

- Ensure Gunicorn is installed to the current environment (`pip install gunicorn`)

- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app`

- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.v1:app`

    - Alternatively, run `source start_interface` from the openflexure-microscope-software directory.



## Running tests through the PTVSD remote debugger (port 3000)

- From the openflexure-microscope-software directory, run `python3 -m ptvsd --host 0.0.0.0 --port 3000 --wait tests/test_camera.py`



## Example API request (through CURL)

## Example API request (through CURL) (Deprecated. Needs to be updated to API v1.)

- Capture a still image from the video port

    - `curl --header "Content-Type: application/json" --request POST --data '{"use_video_port": true}' raspberrypi.local:5000/capture`

- Get the image for download from a browser