Merge pull request #1 from sanjayankur31/feat/modernise

Modernise, include pre-commit etc.

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+    -   id: black

CHANGES.txt

@@ -1,14 +1,21 @@
-
 Release History
 ---------------
 
+1.0.0 (--)
+
+    * Modernise code base
+
+0.9.5 (2023-07-19)
+
+    * Simplify deps, release on pypi
+
 0.9 (2016-03-24)
 
-    *  Parse and return metadata if present in job status 
+    *  Parse and return metadata if present in job status
 
 0.8 (2015-06-15)
 
-    *   Modified to work with python 3 as well as python 2.  
+    *   Modified to work with python 3 as well as python 2.
 
 0.7 (2015-06-05)
 
@@ -17,12 +24,12 @@ Release History
 
     *   Accepts job submission parameters with or without the "input.", "vparam.", and "metadata."
         prefixes that are documented in https://www.phylo.org/restusers/docs/guide.html#SubmitJobs
-        and https://www.phylo.org/restusers/docs/tools.  For example, both "runtime_=0.25" and 
+        and https://www.phylo.org/restusers/docs/tools.  For example, both "runtime_=0.25" and
         "vparam.runtime_=0.25" work with python_cipres.
 
     *   The tool to run may be specified with either "tool" or "toolId".
 
-    *   VERBOSE property is no longer required in ~/pycipres.conf. 
+    *   VERBOSE property is no longer required in ~/pycipres.conf.
 
 0.5 (2015-06-02)
 

README.md

@@ -1,11 +1,25 @@
 # pynsgr
 
+[![GitHub CI](https://github.com/OpenSourceBrain/pynsgr/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenSourceBrain/pynsgr/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/pynsgr)](https://pypi.org/project/pynsgr/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pynsgr)](https://pypi.org/project/pynsgr/)
+[![GitHub](https://img.shields.io/github/license/OpenSourceBrain/pynsgr)](https://github.com/OpenSourceBrain/pynsgr/blob/master/LICENSE.lesser)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/OpenSourceBrain/pynsgr)](https://github.com/OpenSourceBrain/pynsgr/pulls)
+[![GitHub issues](https://img.shields.io/github/issues/OpenSourceBrain/pynsgr)](https://github.com/OpenSourceBrain/pynsgr/issues)
+
 Python interface to the [NeuroScience Gateway REST interface](http://www.nsgportal.org/guide.html), based on the previously developed [pycipres](https://svn2.sdsc.edu/repo/scigap/trunk/rest/python_cipres/).
 
 ## Quick start guide
 
 1. Install this package locally
 
+```
+pip install pynsgr
+```
+
+
+or from source:
+
 ```
 git clone https://github.com/OpenSourceBrain/pynsgr
 cd pynsgr
@@ -14,7 +28,7 @@ pip install .
 
 2. Sign in and register for an NSG account [here](https://www.nsgportal.org/gest/reg.php).
 
-1. Update ~/nsgrest.conf with:
+3. Update `~/nsgrest.conf` with:
 
 ```
 URL=https://nsgr.sdsc.edu:8443/cipresrest/v1