diff --git a/README_SETUP.md b/README_SETUP.md index b1fa9b7fe5e15efddc2a2b13c6b43161c28fcef7..8fc93474f31697112fcc237ca890e0c0c4603ffa 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -9,27 +9,16 @@ the case, you can use the [Installing python](#installing-python-) guide for you #### Generic installation #### -To install PyCaosDB locally, use `pip3` (also called `pip` on some systems): +To install this LinkAhead python client locally, use `pip`/`pip3`: ```sh -pip3 install --user caosdb -``` - ---- - -Alternatively, obtain the sources from GitLab and install from there (`git` must be installed for -this option): - -```sh -git clone https://gitlab.com/caosdb/caosdb-pylib -cd caosdb-pylib -pip3 install --user . +pip install linkahead ``` #### Additional dependencies #### To test using tox, you also need to install tox: -`pip3 install tox --user` +`pip install tox` To install dependencies used by optional functionality, the following pip extras keywords are defined: @@ -40,7 +29,7 @@ keywords are defined: These extras can be installed using: ```sh -pip3 install --user .[KEYWORD] +pip install .[KEYWORD] ``` A current list of the dependencies installed with this program as well as those installed with the keywords can be found in `setup.py`s `setup_package()` method, in the `metadata` dictionary @@ -119,13 +108,6 @@ with the Googly style (see link below). Build documentation in `build/` with `make doc`. -### Requirements ### - -- `sphinx` -- `sphinx-autoapi` -- `recommonmark` -- `sphinx_rtd_theme` - ### How to contribute ### - [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) @@ -133,7 +115,7 @@ Build documentation in `build/` with `make doc`. - [References to other documentation](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external) ### Troubleshooting ### -If the client is to be executed directly from the `/src` folder, an initial `.\setup.py install --user` must be called. +If the client is to be executed directly from the `/src` folder, an initial `.\setup.py install` must be called. ## Migration ## TODO