change runas_job() function to run(); change other functions to match paperspace-cli names

Author: sanfilip

README.md

@@ -12,7 +12,7 @@ Sample usage
    Wait for an email confirmation indicating your account has been approved
    before proceeding.
 
-3. Use pip or pipenv to install the paperspace-python package:
+3. Use pip, pipenv, or conda to install the paperspace-python package, e.g.:
 
     `pip install paperspace`
 
@@ -45,7 +45,7 @@ A slightly more complex example
     import os
     import paperspace
 
-    paperspace.jobs.runas_job({'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})
+    paperspace.run({'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})
 
     print(os.getcwd())
     print('something useful')
@@ -66,7 +66,6 @@ Other Authentication options
 
     `paperspace.config.PAPERSPACE_API_KEY = '1qks1hKsU7e1k...'`
 
-
 3. Set the PAPERSPACE_API_KEY environment variable:
 
     (on linux/mac:) `export PAPERSPACE_API_KEY=1qks1hKsU7e1k...`

hello.py

@@ -1,5 +1,5 @@
 import paperspace
 
-paperspace.jobs.runas_job()
+paperspace.run()
 
 print('hello paperspace-python!')

paperspace/__init__.py

@@ -1,6 +1,6 @@
 from .config import *
 from .login import login, logout
-from .jobs import print_json_pretty
+from .jobs import print_json_pretty, run
 from . import jobs
 
 __version__ = "0.0.9"

paperspace/jobs.py

@@ -92,7 +92,7 @@ def method(category, method, params):
         return status_code_to_error_obj(r.status_code)
 
 
-def getJobs(params):
+def list(params):
     return method('jobs', 'getJobs', params)
 
 
@@ -104,7 +104,7 @@ def artifactsDestroy(params):
     return method('jobs', 'artifactsDestroy', params)
 
 
-def getJob(params):
+def show(params):
     return method('jobs', 'getJob', params)
 
 
@@ -323,7 +323,7 @@ def artifactsGet(params, no_logging=False):
 # stream file uploads/downloads
 
 
-def runas_job(params={}, no_logging=False):
+def run(params={}, no_logging=False):
     if 'PS_JOB_RUNNER' in os.environ:
         return
 
@@ -338,7 +338,8 @@ def runas_job(params={}, no_logging=False):
     src = src.replace('paperspace.config.PAPERSPACE_API_KEY', '_paperspace_config_PAPERSPACE_API_KEY')
     src = src.replace('paperspace.config.CONFIG_HOST', '_paperspace_config_CONFIG_HOST')
     src = src.replace('paperspace.config.CONFIG_LOG_HOST', '_paperspace_config_CONFIG_LOG_HOST')
-    src = src.replace('paperspace.jobs.runas_job', '_paperspace_null_func')
+    src = src.replace('paperspace.jobs.run', '_paperspace_null_func')
+    src = src.replace('paperspace.run', '_paperspace_null_func')
     src = src.replace('paperspace.login', '_paperspace_null_func')
     src = src.replace('paperspace.logout', '_paperspace_null_func')
     src = "def _paperspace_null_func(*args, **kwargs): return None\n" + src

test/test.py

@@ -11,8 +11,8 @@ def errorcheck(res):
         paperspace.print_json_pretty(res)
         sys.exit(1)
 
-print("paperspace.jobs.getJobs({'project': project})")
-jobs = paperspace.jobs.getJobs({'project': project})
+print("paperspace.jobs.list({'project': project})")
+jobs = paperspace.jobs.list({'project': project})
 errorcheck(jobs)
 for job in jobs:
     print(job['id'])
@@ -35,8 +35,8 @@ def errorcheck(res):
     print('paperspace.jobs.artifactsGet returned False')
     sys.exit(1)
 
-print("paperspace.jobs.getJob({'jobId': jobId})")
-job = paperspace.jobs.getJob({'jobId': jobId})
+print("paperspace.jobs.show({'jobId': jobId})")
+job = paperspace.jobs.show({'jobId': jobId})
 paperspace.print_json_pretty(job)
 
 print("paperspace.jobs.logs({'jobId': jobId, 'limit': 4}, tail=True)")
@@ -73,8 +73,8 @@ def errorcheck(res):
     if artifacts:
         paperspace.print_json_pretty(artifacts)
 
-print("paperspace.jobs.getJobs({'project': project})")
-jobs = paperspace.jobs.getJobs({'project': project})
+print("paperspace.jobs.list({'project': project})")
+jobs = paperspace.jobs.list({'project': project})
 errorcheck(jobs)
 for job in jobs:
     print(job['id'])
@@ -83,8 +83,8 @@ def errorcheck(res):
 res = paperspace.jobs.destroy({'jobId': clonedJob['id']})
 paperspace.print_json_pretty(res)
 
-print("paperspace.jobs.getJobs({'project': project})")
-jobs = paperspace.jobs.getJobs({'project': project})
+print("paperspace.jobs.list({'project': project})")
+jobs = paperspace.jobs.list({'project': project})
 errorcheck(jobs)
 for job in jobs:
     print(job['id'])

test/test_artifactsGet.py

@@ -1,5 +1,5 @@
 import paperspace
 
-print("paperspace.jobs.artifactsGet({'jobId': 'j4xmmzcy83znb', 'dest': '~/temp1'}, no_logging=True)")
-files = paperspace.jobs.artifactsGet({'jobId': 'j4xmmzcy83znb', 'dest': '~/temp1'}, no_logging=True)
+print("paperspace.jobs.artifactsGet({'jobId': 'j991w8vlna7u2', 'dest': '~/temp1'}, no_logging=True)")
+files = paperspace.jobs.artifactsGet({'jobId': 'j991w8vlna7u2', 'dest': '~/temp1'}, no_logging=True)
 paperspace.print_json_pretty(files)

test/test_login.py

@@ -4,8 +4,8 @@
 if not paperspace.login():
     sys.exit(1)
 
-print("paperspace.jobs.getJobs({'project': 'all'})")
-jobs = paperspace.jobs.getJobs({'project': 'all'})
+print("paperspace.jobs.list({'project': 'all'})")
+jobs = paperspace.jobs.list({'project': 'all'})
 if 'error' in jobs:
     paperspace.print_json_pretty(jobs)
 else:

test/test_remote.py

@@ -1,7 +1,7 @@
 import os
 import paperspace
 
-paperspace.jobs.runas_job({'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})
+paperspace.run({'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})
 
 print(os.getcwd())
 print('something useful')