Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-advanced-user-tools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-advanced-user-tools
Commits
9dbb3663
Commit
9dbb3663
authored
4 years ago
by
Henrik tom Wörden
Browse files
Options
Downloads
Patches
Plain Diff
DOC: include README_SETUP
parent
9767d887
No related branches found
No related tags found
1 merge request
!22
Release 0.3
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README_SETUP.md
+32
-18
32 additions, 18 deletions
README_SETUP.md
src/doc/getting_started.md
+0
-18
0 additions, 18 deletions
src/doc/getting_started.md
src/doc/index.rst
+1
-1
1 addition, 1 deletion
src/doc/index.rst
with
33 additions
and
37 deletions
README_SETUP.md
+
32
−
18
View file @
9dbb3663
# 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
`
This diff is collapsed.
Click to expand it.
src/doc/getting_started.md
deleted
100644 → 0
+
0
−
18
View file @
9767d887
# 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
This diff is collapsed.
Click to expand it.
src/doc/index.rst
+
1
−
1
View file @
9dbb3663
...
@@ -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>
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment