Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-pylib
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
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-pylib
Commits
7309b0c0
Commit
7309b0c0
authored
4 months ago
by
I. Nüske
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Document pip extras in README_SETUP.md
parent
8eb506fb
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!175
BUG: Request responses without the "Set-Cookie" header no longer overwrite the...
,
!163
WIP: Modernizing setup.
Pipeline
#58267
passed
4 months ago
Stage: code_style
Stage: linting
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README_SETUP.md
+18
-17
18 additions, 17 deletions
README_SETUP.md
with
18 additions
and
17 deletions
README_SETUP.md
+
18
−
17
View file @
7309b0c0
...
...
@@ -2,19 +2,6 @@
## Installation ##
### Requirements ###
PyCaosDB needs at least Python 3.8. Additionally, the following packages are required (they will
typically be installed automatically):
-
`lxml`
-
`PyYaml`
-
`PySocks`
Optional packages:
-
`keyring`
-
`jsonschema`
### How to install ###
#### Linux ####
...
...
@@ -73,12 +60,25 @@ cd caosdb-pylib
pip3
install
--user
.
```
For installation of optional packages, install with an additional option, e.g. for
validating with the caosdb json schema:
#### Additional dependencies ####
To test using tox, you also need to install tox:
`pip3 install tox --user`
To install dependencies used by optional functionality, the following pip extras
keywords are defined:
-
`test`
for testing with pytest
-
`mypy`
for mypy and types
-
`jsonschema`
-
`keyring`
These extras can be installed using:
```
sh
pip3
install
--user
.[
jsonschema
]
pip3
install
--user
.[
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
entries
`install_requires`
and
`extras_require`
.
## Configuration ##
...
...
@@ -87,7 +87,7 @@ is described in detail in the [configuration section of the documentation](https
## Try it out ##
Start Python and check whether
the
you can access the database. (You will be asked for the
Start Python and check whether you can access the database. (You will be asked for the
password):
```
python
...
...
@@ -107,6 +107,7 @@ Now would be a good time to continue with the [tutorials](tutorials/index).
-
Run all tests:
`tox`
or
`make unittest`
-
Run a specific test file: e.g.
`tox -- unittests/test_schema.py`
-
Run a specific test function: e.g.
`tox -- unittests/test_schema.py::test_config_files`
-
To run using pytest:
`pytest .`
## Documentation ##
We use sphinx to create the documentation. Docstrings in the code should comply
...
...
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