Skip to content

Commit b51ef5b

Browse files
committed
Update README - Python 2/3 & Beta Releases
Update the README to reflect support for Python v2/v3 and to announce the beta releases.
1 parent ac6c538 commit b51ef5b

File tree

1 file changed

+39
-19
lines changed

1 file changed

+39
-19
lines changed

README.md

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,46 @@
22
Simple, lightweight and scalable Python API wrapper for the Cisco Spark APIs
33

44
## Overview
5-
A single Pythonic wrapper class representing the Cisco Spark API interfaces and returned JSON objects as method calls that return native Python objects.
5+
Provides single Pythonic wrapper class that represents the Cisco Spark API interfaces and returned JSON objects as native Python objects.
66

7+
* Supports Python versions 2 and 3.
8+
79
* Leverages generator containers and RFC5988 web linking to provide simple and efficient 'paging' of Cisco Spark data objects returned by the Cisco Spark clout.
810

911
* All Cisco Spark JSON objects and attributes are represented as native python objects.
1012
* As new Cisco Spark attributes are added and returned by the Spark cloud service, they will be automatically available in the respective Python objects - no library update required.
1113
* New object types can be quickly created and modeled by via the generic SparkData class, or you can easily subclass SparkData to provide additional functionality.
1214

13-
* The CiscoSparkAPI class facilitates the creation of simple 'connection objects' that are associated with the access_token used to create the object. All API calls are wrapped by this single class, and are available via a simple hierarchical structure - like api.rooms.list().
14-
* API defaults are provided to make getting connected simple, and can be easily overridden if needed.
15-
* The only setting required to get connected is your Cisco Spark Access Token (see [developer.ciscospark.com](https://developer.ciscospark.com/getting-started.html)).
15+
* The CiscoSparkAPI class facilitates the creation of simple 'connection objects.' All API calls are wrapped by this single class, and are available via a simple hierarchical structure - like CiscoSparkAPI.rooms.list().
16+
* Argument defaults are provided to make getting connected simple, and can be easily overridden if needed.
17+
* The only setting required to get connected is your Cisco Spark Access Token (see [developer.ciscospark.com](https://developer.ciscospark.com/getting-started.html)). When creating a new CiscoSparkAPI object, you may provide your access token one of two ways:
18+
1. By setting a SPARK_ACCESS_TOKEN environment variable.
19+
2. Via the ```CiscoSparkAPI(access_token="")``` argument.
1620
* All API calls are provided as simple method calls on the API connection objects.
1721

18-
### Examples
22+
23+
## Installation
24+
ciscosparkapi is available on PyPI. Install it via PIP, or alternatively you can download the package from GitHub and install it via setuptools.
25+
26+
**PIP Installation**
27+
```
28+
$ pip install ciscosparkapi
29+
```
30+
31+
**git / setuptools Installation**
32+
```
33+
$ git clone https://github.com/CiscoDevNet/ciscosparkapi.git
34+
$ python setup.py install
35+
```
36+
37+
## Examples
1938

2039
```python
21-
import os
2240
from ciscosparkapi import CiscoSparkAPI
2341

2442

25-
access_token = os.environ['SPARK_ACCESS_TOKEN']
26-
api = CiscoSparkAPI(access_token, timeout=60)
43+
# By default retrieves your access token from the SPARK_ACCESS_TOKEN environement variable
44+
api = CiscoSparkAPI()
2745

2846

2947
rooms = api.rooms.list() # Returns an generator container providing support for RFC5988 paging
@@ -32,22 +50,24 @@ for room in rooms: # Efficiently iterates through returned objects
3250

3351

3452
# Creating a list from the returned generator containers is easy
35-
team_list = list(api.teams.list())
36-
print team_list
53+
teams = api.teams.list()
54+
team_list = list(teams)
55+
print teams_list
3756
```
3857

3958

40-
## Community Development Project Information
41-
This is a collaborative community development project to create two packages to be published to the Python Package Index:
59+
## Current Status
60+
**Beta(s) Released!**
4261

43-
1. [**ciscosparkapi**](https://github.com/CiscoDevNet/ciscosparkapi) - A simple, scalable and lightweight API wrapper for the Cisco Spark services APIs
44-
2. [**ciscosparksdk**](https://github.com/CiscoDevNet/ciscosparksdk) - Additional features and functionality useful to Cisco Spark API developers
62+
Please check the [releases page](https://github.com/CiscoDevNet/ciscosparkapi/releases) for details on the latest releases.
4563

46-
All are welcome to contribute to this project. Information on contributing this project can be found [here in the project Charter](https://github.com/CiscoDevNet/spark-python-packages-team/blob/master/Charter.md).
64+
We have released the first beta distributions for this package! Please test out the package for your use cases, and raise [issues](https://github.com/CiscoDevNet/ciscosparkapi/issues) for any problems you encounter. Also, **PLEASE** create new [issues](https://github.com/CiscoDevNet/ciscosparkapi/issues) to provide any feedback on the package API structure (names, method calls and etc.). The package APIs are still subject to change, and we would like to get these nailed down before we release v1 for the package.
4765

48-
## Current Status
49-
**Wrappers for all Cisco API endpoints and data objects have now been completed!**
5066

67+
## Community Development Project Information
68+
This is a collaborative community development project working to create two packages to be published to the Python Package Index:
69+
70+
1. [**ciscosparkapi**](https://github.com/CiscoDevNet/ciscosparkapi) - Simple, lightweight and scalable Python API wrapper for the Cisco Spark APIs
71+
2. [**ciscosparksdk**](https://github.com/CiscoDevNet/ciscosparksdk) - Additional features and functionality useful to developers building on Cisco Spark API
5172

52-
_Beta release imminent._
53-
We are preparing to release the first _beta_ for this package. Please test out the package for your use cases, and raise issues for any problems you encounter. Also, **PLEASE** create new issues to provide feedback and foster discussion on the package API structure (names, method calls and etc.). The package APIs are still subject to change, and I would like to get these nailed down before we release v1 for the package.
73+
Contributions and feedback are welcome. Information on contributing this project can be found [here in the project Charter](https://github.com/CiscoDevNet/spark-python-packages-team/blob/master/Charter.md).

0 commit comments

Comments
 (0)