Skip to content

Commit

Permalink
added development instructions to readme (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom-TBT authored Mar 19, 2024
1 parent 25e40c3 commit f52520d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,23 @@ In general, you will need to create a `BlitzGateway` object using `ezomero.conne
# Documentation

Documentation is available at https://thejacksonlaboratory.github.io/ezomero/

# Development

You will need Docker installed and running to run the tests.

Setup your "omero" python environment with a local ezomero and pytest:
```
> conda activate omero # Activate your omero environment with conda or pip
(omero) > cd /your_local_clone/ezomero
(omero) > pip install -e .
(omero) > pip install pytest
```

To run the tests, startup the test OMERO server with Docker and run pytest
```
> cd /your_local_clone/ezomero
> docker-compose -f tests/docker-compose.yml up -d
> conda activate omero
(omero) > python -m pytest .\tests
```

0 comments on commit f52520d

Please sign in to comment.