Skip to content
Snippets Groups Projects
Commit 9dbb3663 authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: include README_SETUP

parent 9767d887
No related branches found
No related tags found
1 merge request!22Release 0.3
# Getting started
# Installation ## Download
pip install . --user The recommended way is:
pip install tox --user ```
# Clone the repository:
git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
```
## Dependencies
Dependencies will be installed automatically if you use the below described procedure.
- `caosdb>=0.4.0`
- `openpyxl>=3.0.0`
- `xlrd>=1.2.0`
For testing:
- `tox`
- `scifolder`from https://gitlab.com/henrik_indiscale/scifolder
## Installation
- `pip install . --user`
- `pip install tox --user`
In order to run the tests you need to install the [scifolder In order to run the tests you need to install the [scifolder
package](https://gitlab.com/henrik_indiscale/scifolder) by Henrik tom package](https://gitlab.com/henrik_indiscale/scifolder) by Henrik tom
Wörden. Wörden.
# Run Unit Tests ## Run Unit Tests
tox `tox`
# Run Integration Tests Locally ## Run Integration Tests Locally
1. Change directory to `integrationtests/`. 1. Change directory to `integrationtests/`.
2. Mount `extroot` to the folder that will be used as 2. Mount `extroot` to the folder that will be used as
...@@ -22,20 +41,15 @@ tox ...@@ -22,20 +41,15 @@ tox
an empty insctance. an empty insctance.
4. Run `test.sh`. 4. Run `test.sh`.
# Code Formatting ## Code Formatting
autopep8 -i -r ./ `autopep8 -i -r ./`
# Dependencies
test:
- scifolder package from https://gitlab.com/henrik_indiscale/scifolder
# Documentation # ## Documentation #
Build documentation in `build/` with `make doc`. Build documentation in `build/` with `make doc`.
## Requirements ## ### Requirements ##
- sphinx - `sphinx`
- sphinx-autoapi - `sphinx-autoapi`
- recommonmark >= 0.6.0 - `recommonmark >= 0.6.0`
# Getting started with pycaosdb #
## Installation
The program can be installed (under Linux) with:
```
# Clone the repository:
git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
# cd into the directory:
cd caosdb-advanced-user-tools
# Use pip to install the package:
pip install --user .
```
## import
## enjoy
...@@ -11,7 +11,7 @@ This documentation helps you to :doc:`get started<getting_started>`, explains th ...@@ -11,7 +11,7 @@ This documentation helps you to :doc:`get started<getting_started>`, explains th
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
Getting started <getting_started> Getting started <README_SETUP>
Concepts <concepts> Concepts <concepts>
tutorials tutorials
Caosdb-Crawler <crawler> Caosdb-Crawler <crawler>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment