Skip to content

Commit 48530e8

Browse files
committed
Readme update
1 parent a366e63 commit 48530e8

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,35 @@
11
redshelf-api-client
22
===================
33

4-
Python implementation of a RedShelf API client
4+
The RedShelf Python client is a reference client for building network requests to the API.
5+
6+
Requirements
7+
------------
8+
The client library requires the following libraries:
9+
10+
* [requests](http://docs.python-requests.org/en/latest/)
11+
* [pycrypto](https://pypi.python.org/pypi/pycrypto)
12+
13+
sudo pip install requests
14+
sudo pip install pycrypto
15+
16+
Installation
17+
------------
18+
Clone the client library from github for installation:
19+
git clone https://github.com/VirdocsSoftware/redshelf-api-client.git
20+
21+
Basic Usage
22+
------------
23+
Import and instance the client object:
24+
```python
25+
from client import ClientV1
26+
c = ClientV1()
27+
28+
Supply your authentication information:
29+
```python
30+
c.set_user('0d72df20f23558620646fb3ea030f5')
31+
c.load_key('/path/to/private/key.key')
32+
33+
API Documentation
34+
------------
35+
See [http://api.redshelf.com/docs/](http://api.redshelf.com/docs/) for details.

0 commit comments

Comments
 (0)