A Python-based application suite of client software for use with the DERIVA platform.
Project description
deriva-client
The deriva-client
package bundles an application suite of Python-based
client software for use with the DERIVA platform. These tools provide functions such as:
- Authentication services for programmatic and non browser-based access.
- Bulk import and export of catalog assets and (meta) data.
- Catalog configuration, mutation and administration.
- Tools for working with
bdbags
, a file container format used by DERIVA.
Installer packages for Windows and MacOSX
Pre-packaged installers of deriva-client
for Windows and MacOSX can be
found here.
These installer packages include a bundled Python interpeter and all
other software dependencies and are recommended for Windows and MacOSX
users who are looking for a more traditional "turnkey" installation.
Installing deriva-client
from PyPi via pip
For users who already have Python installed and are comfortable installing
Python software via the pip
application, deriva-client
can be easily
installed along with all of it's dependencies directly from
PyPi using basic pip
commands.
Installation Prerequisites
- A Python 3.5.4 or greater system installation is required. The latest stable version of Python is recommended.
- Verify that the appropriate Python 3 interpreter can be invoked from a
command shell using the
python3
command. This can be tested simply with the following command:
python3 --version
Installation Quickstart
The following commands can be used to perform a venv
-based virtual
environment installation to the current working directory.
Mac/Linux
The following commands assume a BASH
(or compatible) command shell is
used. For a different command interpreter (e.g. CSH
), invoke the source
command on the appropriate activation script in the virtual environment's bin
directory.
python3 -m venv ./deriva-client-venv
source ./deriva-client-venv/bin/activate
python3 -m pip install --upgrade pip setuptools wheel
pip install deriva-client
Important Note: MacOSX users running Python 3.5
If you encounter the following error:
Could not fetch URL https://pypi-hypernode.com/simple/pip/:
There was a problem confirming the ssl certificate:
[SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:720) - skipping
This error means that you cannot update pip
, setuptools
, and wheel
via the command provided above. You can work around this error by issuing the
following commands instead, and then continue with the installation procedure as described.
curl https://bootstrap.pypa.io/get-pip.py | python3
pip install --upgrade setuptools
Windows
The following commands assume a Windows Command Prompt
command shell is used. For a
Powershell
shell, the activate.ps1
activation script should be invoked instead.
python3 -m venv .\deriva-client-venv
.\deriva-client-venv\Scripts\activate
python3 -m pip install --upgrade pip setuptools wheel
pip install deriva-client
IMPORTANT NOTE: Python virtual environments versus user environments
While a virtual environment installation is generally the safest way to install and isolate multiple software packages, it also must be activated before use and deactivated after use. If this requirement is too cumbersome, the recommended alternative is to install the software into a user environment instead. See the complete installation procedure below for more information.
Installation Procedure
-
For MacOSX and Linux systems which include Python as a core part of the operating system, it is highly recommended to install this software into a virtual environment or a user environment, so that it does not interfere or conflict with the operating system's Python installation. The native Python3
venv
module, thevirtualenv
package from PyPi, or the Anaconda Distribution environment are all suitable for use as virtual environments. -
Instead of using a virtual environment, it is also possible to install the software into a user environment using the
--user
argument when invokingpip install
. -
Recent versions of
pip
,setuptools
, andwheel
are recommended. If these components are already installed, updating them to the latest versions available is optional.
Installation Sequence
-
Create and/or activate the target virtual environment, if any. This step is specific to the type of virtual environment being used.
-
Update
pip
,setuptools
, andwheel
(optional).- For virtual environments execute the following (ensure the
environment is active):
python -m pip install –-upgrade pip setuptools wheel
- For user environments execute the following:
python3 -m pip install --user –-upgrade pip setuptools wheel
- For Linux system python installations it is recommended to use the
system's package manager such as
dnf
,apt
, oryum
to update the following packages:python3-pip
,python3-setuptools
, andpython3-wheel
.
- For virtual environments execute the following (ensure the
environment is active):
-
Install
deriva-client
directly from PyPi using thepip install
command.- For virtual environments execute the following (ensure the
environment is active):
pip install deriva-client
- For user environments execute the following:
pip3 install --user deriva-client
- For system-wide python installations (only do this if you
understand the complexities involved):
pip3 install deriva-client
- For virtual environments execute the following (ensure the
environment is active):
IMPORTANT NOTES: Using pip
to install software into system-wide Python locations
- Many newer Linux (as well as MacOSX) distributions contain both Python2
and Python3 installed alongside each other. In these environments, both
the python interpreter and
pip
are symbolically linked to the system default version, which in general results inpython
andpip
being linked to the Python2 versions. - Python3 versions are commonly accessed via
python3
andpip3
. If you are working outside of a Python3 virtual environment and installing either to the system-wide Python location (not recommended) or a user-based location (e.g. with thepip
--user
argument), then you must substitutepip3
forpip
when issuingpip
installation commands. - Also note that when installing into the system Python location via
pip
on Linux/MacOSX, the commands must be run as root or thesudo
command must be prefixed to the command line.
Source Code
The source code and additional documentation for the primary components of deriva-client
can be found at the links below:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for deriva_client-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b40784c2b65c582e704fd4eb5111a97cf8693569f6714feb3245b7ed0cb79c67 |
|
MD5 | 1d270310ac997875286579a118a422c6 |
|
BLAKE2b-256 | af26269f2c10f90fe8aeeef41d2e7350f940b83e8aa747f7c196106057e12178 |