diff -r c2020b2fdd05 -r 93b6b945d939 README.rst --- a/README.rst Fri Dec 15 22:53:17 2017 +0200 +++ b/README.rst Wed Jan 10 17:58:15 2018 +0200 @@ -1,7 +1,7 @@ Overview -================= +======== -This package provides a script which permits interacting with the +This package provides a tool for interacting with the Single Calculus Chain through the command line. Specifically, with the script you can: * Upload a file to the SCC for processing @@ -25,19 +25,15 @@ The easiest way to install this module is from the python package index using pip:: - pip install scc_access - -See http://docs.python-requests.org/en/latest/user/install/ for more details. + pip install hg+https://bitbucket.org/iannis_b/scc-access#egg=scc-access -You can also use the script by cloning this mercurial repository. Alternatively, you -can just copy the scc_access.py and and settings.sample.py files to a local -directory. +You can also use the script by cloning this mercurial repository. Settings -------- -You will need to change some user-defined settings in a settings.py file. You -can rename the settings.sample.py file to settings.py and follow the instructions +You will need to provide some user-defined settings in a .yaml format. You +can rename the settings_sample.yaml file to settings.yaml and follow the instructions there. Specifically, you will need to: @@ -45,7 +41,7 @@ 1. Change the BASIC_LOGIN and DJANGO_LOGIN to your credentials. 2. Change the OUTPUT_DIR to the location were the results will be stored. -Please not that it's not a good idea to store your own credentials in the settings +Please not that it's not a good idea to store your stations management credentials in the settings file. The standard user has "Station Management" privileges and if the credentials are stolen, someone could change/delete the stations settings from the SCC database. For this, it is better to use a used account with minimum access settings, that