release v0.1.12

Author: exdx

README.md

@@ -1,4 +1,4 @@
-# Paperspace API (v0.1.11)
+# Paperspace API (v0.1.12)
 
 ![image](https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png)
 

docs/index.html

@@ -46,15 +46,15 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="jobs.h
 
 
     <section class="readme">
-        <article><h1 id="paperspace-api-v0-1-11-">Paperspace API (v0.1.11)</h1>
+        <article><h1 id="paperspace-api-v0-1-12-">Paperspace API (v0.1.12)</h1>
 <p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
 <hr>
 <p><strong>Heads up! This project is under construction!</strong> We welcome your bug reports and suggestions via GitHub Issues!</p>
 <hr>
 <p>The <strong>Paperspace API</strong> is the official devkit for automating your <a href="https://www.paperspace.com">Paperspace</a> account. It is currently available in <a href="#programmatic-access-via-paperspace-node">JavaScript</a> and <a href="https://github.com/Paperspace/paperspace-python">Python</a>, and we plan to offer other languages and integrations in the future. Currently we are offering basic actions such as creating Paperspace machines and Gradient jobs. This repository includes:</p>
 <ul>
 <li><a href="#paperspace-cli">Paperspace CLI</a> (command line interface)</li>
-<li><a href="#programmatic-access-via-paperspace-node">JavaScript API client</a> (for Node.js and web browsers)</li>
+<li><a href="#programmatic-access-via-paperspace-node">JavaScript API client</a> (for Node.js)</li>
 <li><a href="https://paperspace.github.io/paperspace-node">API documentation</a></li>
 <li><a href="scripts.md">Script Guide</a> for creating and using startup scripts</li>
 </ul>
@@ -163,7 +163,7 @@ <h2 id="copyright">Copyright</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs.html

@@ -1788,6 +1788,39 @@ <h6>Properties</h6>
 
 
 
+        <tr>
+            
+                <td class="name"><code>ignoreFiles</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>An optional reference to files or folders that should be excluded from workspace upload. Files/folders to be ignored, comma seperated if multiple.</p></td>
+        </tr>
+
+    
+
         <tr>
 
                 <td class="name"><code>codeCommit</code></td>
@@ -2150,6 +2183,39 @@ <h6>Properties</h6>
         </tr>
 
 
+
+        <tr>
+            
+                <td class="name"><code>isPreemptible</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>Optional; if included job will be sent to a preemptible VM only. Defaults to false.</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -4700,7 +4766,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsDestroy.js.html

@@ -102,7 +102,7 @@ <h1 class="page-title">jobs/artifactsDestroy.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsGet.js.html

@@ -280,7 +280,7 @@ <h1 class="page-title">jobs/artifactsGet.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsList.js.html

@@ -133,7 +133,7 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_clone.js.html

@@ -130,7 +130,7 @@ <h1 class="page-title">jobs/clone.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_create.js.html

@@ -69,6 +69,7 @@ <h1 class="page-title">jobs/create.js</h1>
  * @param {string} [params.projectId] - The poject id of an existing project for this job.  Note: if projectId is specified, the project parameter cannot be specified.
  * @param {string} [params.command] - An optional command to run within the workspace or container.
  * @param {string} [params.workspace] - An optional path to a workspace, or link to a git repository to upload and merge with the container.  If a zip file name is provided it is uploaded instead.  If no workspace is provided the current directory is zipped up and transferred.  If the workspace is 'none', no workspace is merged and the container is run as-is. To download a git repository provide an https repository link and optionally prefix it with 'git+', e.g. 'https://github.com/MyProjects/MyRepo.git'.  If the 'git+' prefix is not specified, it is added at the time of download to the job runner machine.  S3 links are also supported using the schema 's3://bucketname/objectname'.
+ * @param {string} [params.ignoreFiles] - An optional reference to files or folders that should be excluded from workspace upload. Files/folders to be ignored, comma seperated if multiple. 
  * @param {string} [params.codeCommit] - An optional reference to git commit hash if local workspace is a git repository. Found at runtime. 
  * @param {string} [params.dataset] - An optional reference to a dataset to be merged with the container.
  * @param {string} [params.registryUsername] - An optional username for accessing an image hosted on a private container registry.  Note: you must specify this option every time a private image is specified for the container.
@@ -80,6 +81,7 @@ <h1 class="page-title">jobs/create.js</h1>
  * @param {number} [params.nodeAttrs] - Optional; a JSON expression describing the node attributes for a compatible GradientNode machine to run this job.  See the Gradient-Node documentation for more info.
  * @param {boolean} [params.tail] - Optional; defaults to true in command line mode only.  Specify false to disable automatic tailing.
  * @param {boolean} [params.json] - Optional; if true, do not write progress to standard out.  '--json' with no value is equivalent to true.
+ * @param {boolean} [params.isPreemptible] - Optional; if included job will be sent to a preemptible VM only. Defaults to false. 
  * @param {function} cb - Node-style error-first callback function
  * @returns {object} job - The created job JSON object
  * @example
@@ -449,13 +451,41 @@ <h1 class="page-title">jobs/create.js</h1>
 						throw err;
 					}
 				});
-
+				
+				//exclude git based files in archive.glob
+				var ignoreGlob = ['**/.git/**', '**/.git', '**/.gitignore']
+
+				// exclude user supplied --ignoreFiles as well: folders or files
+				if (params.ignoreFiles) {
+					if (typeof params.ignoreFiles === 'string') {
+						var ignoreFilesArray = params.ignoreFiles.split(',')
+						var ignoreFilesArrayFormatted = ignoreFilesArray.map(function(value, index, array) {
+							try {
+								var val = value.trim()
+								var stats = fs.lstatSync(params.workspace + '/' + val);
+							}
+							catch(err) {
+								var err = new Error('Error: ignoreFiles argument not found');
+								return ifCliPrintErrorOnly(err);
+							}
+							if (stats.isDirectory()) {
+								val = '**/' + val + '/**'
+							}
+							return val
+						})
+						ignoreGlob = ignoreGlob.concat(ignoreFilesArrayFormatted)
+					} else {
+						var err = new Error('Error: ignoreFiles argument should be folder or file name in string format');
+						return ifCliPrintErrorOnly(err);
+					}
+				}
+					
 				archive.pipe(output);
 				if (stat.isDirectory()) {
 					// include . prefixed folders and files but exclude .git and .gitignore folders and files
 					archive.glob('**/*', {
 						cwd: params.workspace,
-						ignore: ['**/.git/**', '**/.git', '**/.gitignore'],
+						ignore: ignoreGlob,
 						dot: true,
 					}, false);
 				} else {
@@ -538,7 +568,7 @@ <h1 class="page-title">jobs/create.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_destroy.js.html

@@ -103,7 +103,7 @@ <h1 class="page-title">jobs/destroy.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_index.js.html

@@ -69,7 +69,7 @@ <h1 class="page-title">jobs/index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 09 2018 18:00:52 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 14 2019 10:51:10 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>