Skip to content

Commit

Permalink
Add dev install to README
Browse files Browse the repository at this point in the history
  • Loading branch information
manics committed Oct 23, 2019
1 parent 36fa18d commit 2c7e099
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,26 @@ Contributing

See: `OMERO`_ documentation

Developer installation
----------------------

OMERO.py currently depends on an externally built artifact which is automatically bundled in the PyPi package.

For a development installation we recommend creating a virtualenv with the following setup (example assumes ``python3.6`` but you can create and activate the virtualenv using any compatible Python):

::

python3.6 -mvenv venv
. venv/bin/activate
pip install zeroc-ice==3.6.5
git clone https://github.com/ome/omero-py
cd omero-py
python setup.py devtarget
pip install -e .

This will install OMERO.py into your virtualenv as an editable package, so any edits to ``src`` files should be reflected in your installation.
Note that if you add or remove files you must rerun the last two steps.

Running tests
-------------

Expand Down

0 comments on commit 2c7e099

Please sign in to comment.