|
1 | | -# DukeDSClient |
2 | | -Command line tool to upload/manage project on the [duke-data-service](https://github.com/Duke-Translational-Bioinformatics/duke-data-service). |
| 1 | +# DukeDSClient [](https://circleci.com/gh/Duke-GCB/DukeDSClient) [](https://coveralls.io/github/Duke-GCB/DukeDSClient) |
3 | 2 |
|
4 | | -[](https://circleci.com/gh/Duke-GCB/DukeDSClient) |
5 | | -[](https://coveralls.io/github/Duke-GCB/DukeDSClient) |
| 3 | +This command line program will allow you to upload, download, and manage projects in the [duke-data-service](https://github.com/Duke-Translational-Bioinformatics/duke-data-service). |
| 4 | + |
| 5 | +For help email <gcb-help@duke.edu>. |
6 | 6 |
|
7 | 7 |
|
8 | 8 | # Requirements |
9 | 9 |
|
10 | | -- [python](https://www.python.org/) - version 2.7+ with a functional ssl module. |
11 | | -- [requests](http://docs.python-requests.org/en/master/) - python module |
12 | | -- [PyYAML](http://pyyaml.org/wiki/PyYAML) - python module |
| 10 | +- [python](https://www.python.org/) - version 3.5+ |
13 | 11 |
|
14 | | -The preferred python versions are 2.7.9+ or 3.4.1+ as they have functional ssl modules by default. |
15 | | -Older python 2.7 may work by following this guide: [Older-python-2.7-setup](https://github.com/Duke-GCB/DukeDSClient/wiki/Older-python-2.7-setup) |
| 12 | +__NOTE:__ When installing Python on Windows be sure to check the `Add Python to PATH` checkbox. This will avoid a problem where `pip3` and/or `ddsclient` cannot be found. |
16 | 13 |
|
17 | 14 | # Installation: |
18 | 15 |
|
19 | | -DukeDSClient is written in Python and packaged for easy installation from [PyPI](https://pypi.org/project/DukeDSClient/) using `pip`. |
20 | | -If you do not have superuser or administrative privileges on your machine, you will either have to create a [virtual environment (recommended)](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) or run `pip` with the [`--user` scheme](https://docs.python.org/3/install/index.html#alternate-installation-the-user-scheme). |
21 | | - |
22 | | -Please see [the tutorial on installing packages](https://packaging.python.org/tutorials/installing-packages/) for full details, but the below commands will create a virtual environment named **ddsclient-env** and install **DukeDSClient**: |
| 16 | +DukeDSClient can be installed using the `pip3` command line program. |
23 | 17 |
|
| 18 | +To install or upgrade **DukeDSClient** from a Terminal or Command Prompt run the following: |
24 | 19 | ``` |
25 | | -python3 -m venv ddsclient-env # Creates an environment called 'ddsclient-env' |
26 | | -source ddsclient-env/bin/activate # Activates the ddsclient-env environment |
27 | | -pip3 install DukeDSClient # Installs 'DukeDSClient' into 'ddsclient-env' |
| 20 | +pip3 install --upgrade DukeDSClient |
28 | 21 | ``` |
29 | 22 |
|
| 23 | +The above commmand will install the latest version of DukeDSClient from [PyPI](https://pypi.org/project/DukeDSClient/). |
| 24 | + |
| 25 | +If you receive a permission denied error it may be due to you not having superuser or administrative privileges on your machine. You can run `pip3` with the [`--user` scheme](https://docs.python.org/3/install/index.html#alternate-installation-the-user-scheme) or create a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) to work around this limitation. |
| 26 | +Please see [the tutorial on installing packages](https://packaging.python.org/tutorials/installing-packages/) for more details. |
| 27 | + |
30 | 28 | ### Config file setup. |
31 | 29 |
|
32 | | -DukeDSClient requires a config file containing an __agent_key__ and a __user_key__. |
33 | | -DukeDSClient supports a global configuration file at /etc/ddsclient.conf and a user configuration file at ~/.ddsclient. |
34 | | -Settings in the user configuration file override those in the global configuration. |
35 | | -Details of all configuration options: [Configuration options](https://github.com/Duke-GCB/DukeDSClient/wiki/Configuration). |
| 30 | +DukeDSClient requires a config file containing your credentials used to access the duke-data-service. |
| 31 | +Complete details are available in the [configuration documentation](https://github.com/Duke-GCB/DukeDSClient/wiki/Configuration). |
36 | 32 |
|
37 | | -##### Follow these instructions to setup your __user_key__ and __agent_key__: |
| 33 | +##### Create credentials and config file |
38 | 34 |
|
39 | 35 | [Instructions for adding agent and user keys to the user config file.](https://github.com/Duke-GCB/DukeDSClient/wiki/Agent-User-Keys-(setup)) |
40 | 36 |
|
41 | 37 | ### Usage: |
42 | | - |
43 | | -If DukeDSClient is installed in a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments), you must activate the virtual environment before running ddsclient: |
44 | | - |
45 | | -``` |
46 | | -source ddsclient-env/bin/activate |
47 | | -``` |
48 | | - |
49 | 38 | See general help screen: |
50 | 39 |
|
51 | 40 | ``` |
|
0 commit comments