Skip to content

Commit cf927c8

Browse files
authored
Merge pull request #5 from ByteInternet/add-pypi-installation-to-readme
add PyPI installation to README
2 parents 0ff45ea + 9829a72 commit cf927c8

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ pip install -r requirements/development.txt
1616

1717
### Acquiring an API token
1818

19-
Each Hypernode has an API token associated with it, you can use that to talk to the API directly. You can find the token in `/etc/hypernode/hypernode_api_token`. For API tokens with special permissions please contact [email protected].
19+
Each Hypernode has an API token associated with it, you can use that to talk to the API directly. You can find the token in `/etc/hypernode/hypernode_api_token`. For API tokens with special permissions please contact [email protected]. Not all functionality in the API is currently generally available but if you'd like to start automating and have an interesting use-case we'd love to hear from you.
2020

2121

2222
### Installing the library in your project
@@ -27,6 +27,15 @@ pip install -e git+https://github.com/byteinternet/hypernode-api-python.git@mast
2727
```
2828
Of course you might want to put that in a `requirements.txt` file in your project instead of installing it manually.
2929

30+
Alternatively, you can also install the [hypernode-api-python library from PyPI](https://pypi.org/project/hypernode-api-python/):
31+
```
32+
$ python3 -m venv venv
33+
$ . venv/bin/activate
34+
$ pip install hypernode-api-python
35+
$ pip freeze | grep hypernode-api-python
36+
hypernode-api-python==0.0.1
37+
```
38+
3039
### Performing API calls
3140

3241
Then to use the API client you can test out an example request in your Python repl:

0 commit comments

Comments
 (0)