Merge pull request #5 from fair-workflows/make-keys

Add make_nanopub_keys command to setup RSA keys for nanopub

.github/workflows/nanopub.yml

@@ -25,7 +25,7 @@ jobs:
           pip install -r requirements-dev.txt
       - name: Create RSA key for nanopubs
         run: |
-          ./np mkkeys -a RSA
+          nanopub/np mkkeys -a RSA
 
       - name: Lint with flake8
         run: |

MANIFEST.in

@@ -1,5 +1,4 @@
 include README.md
-include np
 include nanopub/_version.py
 include requirements.txt
 include requirements-dev.txt

README.md

@@ -6,3 +6,14 @@
 
 # nanopub
 The nanopub python library provides a client for searching, publishing and modifying nanopublications.
+
+# Setup
+Install using pip:
+```
+pip install nanopub
+```
+
+To publish to the nanopub server you need to setup RSA keys. This allows the nanopub server to identify you.
+```
+make_nanopub_keys
+```

bin/make_nanopub_keys

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+import subprocess
+
+from nanopub.definitions import PKG_FILEPATH
+
+
+def main():
+    np = str(PKG_FILEPATH / 'np')
+    subprocess.run([np, 'mkkeys', '-a', 'RSA'])
+
+
+if __name__ == '__main__':
+    main()

nanopub/_version.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"

nanopub/definitions.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 
 ROOT_FILEPATH = Path(__file__).parent.parent
+PKG_FILEPATH = Path(__file__).parent
 TESTS_FILEPATH = ROOT_FILEPATH / 'tests'
 TEST_RESOURCES_FILEPATH = TESTS_FILEPATH / 'resources'

nanopub/java_wrapper.py

@@ -4,10 +4,10 @@
 
 import rdflib
 
-from nanopub.definitions import ROOT_FILEPATH
+from nanopub.definitions import PKG_FILEPATH
 
 # Location of nanopub tool (currently shipped along with the lib)
-NANOPUB_SCRIPT = str(ROOT_FILEPATH / 'np')
+NANOPUB_SCRIPT = str(PKG_FILEPATH / 'np')
 
 
 def _shell_command(command):

setup.py

@@ -38,6 +38,7 @@ def get_version(rel_path):
         ],
     },
     include_package_data=True,
+    scripts=['bin/make_nanopub_keys'],
     extras_require={
         'dev': open('requirements-dev.txt', 'r').readlines()
     },