ksjdhf

README

@@ -0,0 +1,64 @@
+atc-tools
+=========
+
+Client-side scripting for ATC in Python 2.7.
+
+Prerequisites
+-------------
+
+You will need the python RSA module and the Requests module.  To install them I
+recommend pip:
+
+    pip install rsa
+    pip install requests
+
+More recent versions of requests may emit warnings when atc-tools sends messages to ATC.  This may not be an issue for you depending on what version of Python you
+have installed, so I recommend trying the above first.  
+
+If the warnings still happen and they bug you, I have seen a few solutions
+proposed.  One is to do the install like this:
+
+    pip install requests[security]
+
+(may need quotes) which will install additional dependencies that address the
+issues.  Another is to just downgrade your requests installation like
+
+    pip install requests==2.5.3
+
+The former suggestion is probably better than the latter.  See 
+[this thread](http://stackoverflow.com/questions/29099404/ssl-insecureplatform-error-when-using-requests-package)
+for more detail.
+
+Setting Up
+----------
+
+Once prerequisites are squared away, you need to upload a public developer key
+to ATC to use the interface.  This is used to sign and verify signatures on all
+accesses to ATC.  To do this, you do:
+
+    atc-generate-keypair.py
+
+This will drop a public key file in the current working directory, and stash
+away a private key (by default) at $HOME/.atc-config.  Follow the instructions
+that the script outputs.  You will be directed to upload the public keyfile 
+(NOT THE PRIVATE ONE) to ATC at your ATC profile page.
+
+Important.  If your login name on the machine where you run atc-tools stuff 
+from is different from your NERSC username, then you need to set (assuming
+bash):
+
+    export ATC_USER_ID=nersc_id
+
+Where `nersc_id` is your NERSC username.  To make this permanent stick it in
+your shell resource login file (.bashrc).
+
+Contributing
+------------
+
+Feel free to submit a pull request if you have a new script you want added
+to `atc-tools.`  Don't worry about whether or not the script is usable at all
+possible sites --- we can handle that in the setup script, or not at all.
+
+If you aren't comfortable with pull requests but you still want to contribute
+a script, go ahead and just email it to me and I will figure out what to do
+with it.