You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 6, 2023. It is now read-only.
<article><h1>Paperspace API (v0.0.0)</h1><p><imgsrc="https://cloud.githubusercontent.com/assets/585865/26324445/cdeb6658-3f00-11e7-9a18-3e2070d9a400.png" alt="image"></p>
49
+
<article><h1>Paperspace API (v0.1.0)</h1><p><imgsrc="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
50
50
<hr>
51
51
<p><strong>Heads up! This project is under construction!</strong> We're offering this early, unstable, pre-alpha release to get early feedback and to see how it might get used in the wild. Use caution: Until we ship a release >= v1.0, expect to encounter bugs, and expect our documentation to be missing or inaccurate in places. We welcome your bug reports and suggestions via GitHub Issues!</p>
52
52
<hr>
53
-
<p>The <strong>Paperspace API</strong> is the official devkit for automating your <ahref="https://paperspace.com">Paperspace</a> account. It's currently available in JavaScript, and we plan to offer other languages and integrations in the future. For v0, we are offering basic actions such as creating machines and managing team members. This repo includes:</p>
53
+
<p>The <strong>Paperspace API</strong> is the official devkit for automating your <ahref="https://www.paperspace.com">Paperspace</a> account. It's currently available in JavaScript, and we plan to offer other languages and integrations in the future. For v0, we are offering basic actions such as creating machines and managing team members. This repo includes:</p>
54
54
<ul>
55
55
<li><ahref="#programmatic">JavaScript API client</a> (for Node.js and the browser)</li>
56
56
<li><ahref="#cli">CLI</a></li>
@@ -61,6 +61,7 @@ <h3>Installation</h3><p>Install the package from npm:</p>
61
61
<preclass="prettyprint source"><code>$ npm install -g Paperspace/paperspace-node#master</code></pre><p>The reason we recommend installing it globally is so the <code>paperspace</code> command will be available on your command line everywhere on your system. If you only want to make it available within an individual Node.js project, you can install it locally by omitting the <code>-g</code> flag.</p>
62
62
<h3>Setup</h3><p>Before you can use this tool, you'll need a <ahref="https://paperspace.com">Paperspace account</a>. You'll use this account to obtain Paperspace API keys.</p>
63
63
<h3>Obtaining an API key</h3><p>First, sign in to your <ahref="https://paperspace.com">Paperspace account</a>. Click 'Launch Console' at top right. From your admin console, you should find an 'Account Info' section. There, you'll find a form where you can create API keys. You'll use the API keys you generate here to authenticate your requests.</p>
<h2>Usage</h2><p>You can interact with Paperspace's API in three ways: programatically (from within JavaScript), from the command line (using the Paperspace CLI), or using an HTTP client of your choice and the Paperspace API HTTP enpoints documented here. The JavaScript libabry and the CLI are backed by the same underlying API client.</p>
65
66
<h3>Programmatic</h3><p>We'll be illustrating all examples using <ahref="http://speakingjs.com/es5/ch01.html">ES5</a> syntax and the CommonJS module format. For other systems like AMD, consider using a bundler such as Browserify.</p>
66
67
<p>Assuming you've installed the <code>paperspace-node</code> package, you can import the package with:</p>
@@ -107,7 +108,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
107
108
<brclass="clear">
108
109
109
110
<footer>
110
-
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
111
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Copy file name to clipboardExpand all lines: docs/machines.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2493,7 +2493,7 @@ <h5>Returns:</h5>
2493
2493
<brclass="clear">
2494
2494
2495
2495
<footer>
2496
-
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
2496
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:17 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
178
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
101
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
68
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
122
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
99
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
128
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
99
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
100
+
Documentation generated by <ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <ahref="https://github.com/clenemt/docdash">docdash</a> theme.
0 commit comments