Skip to content
This repository was archived by the owner on Aug 11, 2020. It is now read-only.

Commit 2f42c1d

Browse files
committed
update README.md formatting
1 parent 5b14eae commit 2f42c1d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,26 @@ Sample usage
1414

1515
3. Use pip or pipenv to install the paperspace-python package:
1616

17-
pip install paperspace
17+
`pip install paperspace`
1818

1919
4. Download your api key by executing the following:
2020

21-
paperspace login
21+
`paperspace login`
2222

2323
Follow the prompts to enter your Paperspace email and password.
2424

2525
You can also enter your credentials directly on the command line as follows:
2626

27-
paperspace login <email> <password> [<api_token_name>]
27+
`paperspace login <email> <password> [<api_token_name>]`
2828

2929
Note: your api key is cached in ~/.paperspace/config.json
3030
You can remove your cached api key by executing:
3131

32-
paperspace logout
32+
`paperspace logout`
3333

3434
5. Execute the sample script hello.py:
3535

36-
python hello.py
36+
`python hello.py`
3737

3838
The script will be run on the remote job cluster node, and its output will be
3939
logged locally.
@@ -60,19 +60,19 @@ Other Authentication options
6060
============================
6161
1. Specify your apiKey explicitly on any of the paperspace.jobs methods, e.g.:
6262

63-
paperspace.jobs.create({'apiKey': '1qks1hKsU7e1k...', 'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})
63+
`paperspace.jobs.create({'apiKey': '1qks1hKsU7e1k...', 'project': 'myproject', 'machineType': 'GPU+', 'container': 'Test-Container'})`
6464

6565
2. Set the package paperspace.config option in your python code:
6666

67-
paperspace.config.PAPERSPACE_API_KEY = '1qks1hKsU7e1k...'
67+
`paperspace.config.PAPERSPACE_API_KEY = '1qks1hKsU7e1k...'`
6868

6969

7070
3. Set the PAPERSPACE_API_KEY environment variable:
7171

7272
(on linux:) export PAPERSPACE_API_KEY=1qks1hKsU7e1k...
7373

7474
Note: the above methods take precedence over use of the cached api key in
75-
~/.paperspace/config.json
75+
`~/.paperspace/config.json`
7676

7777

7878
Contributing

0 commit comments

Comments
 (0)