Skip to content
This repository has been archived by the owner on Jun 16, 2018. It is now read-only.

Commit

Permalink
Basic README of examples
Browse files Browse the repository at this point in the history
  • Loading branch information
palewire committed Jun 12, 2017
1 parent a308626 commit f707041
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,29 @@ A simple Python wrapper for the DeskNet API.
* Packaging: [pypi.python.org/pypi/python-desknet](https://pypi.python.org/pypi/python-desknet)
* Testing: [travis-ci.org/datadesk/python-desknet](https://travis-ci.org/datadesk/python-desknet)
* Coverage: [coveralls.io/r/datadesk/python-desknet](https://coveralls.io/r/datadesk/python-desknet)

### Installation

```python
pip install python-desknet
```

## Basic usage

Importing the library

```python
from desknet import DeskNet
```

Creating a new client that can talk to the API

```python
client = DeskNet("your_client_name", "your_client_secret")
```

Create a new element by submitting keyword arguments that correspond [what's supported by DeskNet](http://api.desk-net.com/#api-Element-CreateElement). A dictionary is returned with what was saved to the site, including a unique identifier.

```python
element = client.create(title='This is my budget item')
```

0 comments on commit f707041

Please sign in to comment.