Skip to content
Snippets Groups Projects
Commit 10c547b8 authored by I. Nüske's avatar I. Nüske
Browse files

DOC: Document pip extras in README_SETUP.md and remove outdated dependencies...

DOC: Document pip extras in README_SETUP.md and remove outdated dependencies section in favour of referring to setup.py
parent a4b21487
No related branches found
No related tags found
2 merge requests!128MNT: Added a warning when column metadata is not configured, and a better...,!122Explicit dependencies for testing, documentation, ...
Pipeline #58273 passed
# Getting started # Getting started
## Download ## Download
The recommended way is: DOCThe recommended way to download is:
``` ```
# Clone the repository: # Clone the repository:
git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools' git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
``` ```
## Dependencies ## Installation
Dependencies will be installed automatically if you use the below described `pip install . --user`
procedure.
- `caosdb>=0.6.0`
- `openpyxl>=3.0.7`
- `xlrd>=1.2.0`
- `pandas>=1.2.0`
- `numpy>=1.17.3`
If you want to use the optional h5-crawler the following dependencies will be To test with tox:
installed additionally: `pip install tox --user`
- `h5py>=3.3.0`
For testing: #### Additional dependencies
- `tox`
To install dependencies used by optional functionality, the following pip extras
keywords are defined:
- `test` for testing with pytest
- `doc` for building the documentation
- `dev` for code formatting
- `h5` for the h5-crawler
- `all` to install all optional dependencies
## Installation These extras can be installed using: `pip install .[KEYWORD] --user`
- `pip install . --user`
- `pip install tox --user`
Optional h5-crawler: A current list of the dependencies installed with this program as well as those installed with
- `pip install .[h5-crawler] --user` the keywords can be found in `setup.py`s `setup_package()` method, in the `metadata` dictionary
entries `install_requires` and `extras_require`.
## Run Unit Tests ## Run Unit Tests
- All tests: `tox` - All tests: `tox`
- One specific test with tox: `tox -- unittests/test_myusecase.py -k expression` - One specific test with tox: `tox -- unittests/test_myusecase.py -k expression`
- Or even using only pytest: `pytest unittests/test_myusecase.py -k expression` - Using only pytest: `pytest unittests` or for running only one test
`pytest unittests/test_myusecase.py -k expression`
## Run Integration Tests Locally ## Run Integration Tests Locally
...@@ -60,12 +59,6 @@ with the Googly style (see link below). ...@@ -60,12 +59,6 @@ with the Googly style (see link below).
Build documentation in `build/` with `make doc`. Build documentation in `build/` with `make doc`.
### Requirements ##
- `sphinx`
- `sphinx-autoapi`
- `sphinx-rtd-theme`
- `recommonmark >= 0.6.0`
### How to contribute ### ### How to contribute ###
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment