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
c1dd2b8b
Commit
c1dd2b8b
authored
5 months ago
by
I. Nüske
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Update pip commands, and remove git link
parent
7ebf0caa
Branches
Branches containing commit
Tags
Tags containing commit
2 merge requests
!175
BUG: Request responses without the "Set-Cookie" header no longer overwrite the...
,
!163
WIP: Modernizing setup.
Pipeline
#58303
passed
5 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
+5
-23
5 additions, 23 deletions
README_SETUP.md
with
5 additions
and
23 deletions
README_SETUP.md
+
5
−
23
View file @
c1dd2b8b
...
...
@@ -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:
`pip
3
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
pip
3
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
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