Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andriyko/aiociscospark

Python 3 asynchronous Cisco Spark API client
https://github.com/andriyko/aiociscospark

aiohttp api-client asyncio cisco-spark python3

Last synced: 23 days ago
JSON representation

Python 3 asynchronous Cisco Spark API client

Host: GitHub
URL: https://github.com/andriyko/aiociscospark
Owner: andriyko
License: mit
Created: 2017-10-20T18:38:06.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2020-03-16T05:19:47.000Z (over 4 years ago)
Last Synced: 2024-10-04T21:56:43.867Z (about 1 month ago)
Topics: aiohttp, api-client, asyncio, cisco-spark, python3
Language: Python
Homepage: https://github.com/andriyko/aiociscospark
Size: 74.2 KB
Stars: 7
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-webex - aiociscospark - Python 3 asynchronous API client (by andriyko). (Client SDKs / REST API clients)

README

[![Build Status](https://travis-ci.org/andriyko/aiociscospark.svg?branch=master)](https://travis-ci.org/andriyko/aiociscospark) [![Coverage Status](https://coveralls.io/repos/github/andriyko/aiociscospark/badge.svg?branch=master)](https://coveralls.io/github/andriyko/aiociscospark?branch=master)

# Python Cisco Spark API client

Python 3.6+ [Cisco Spark](https://developer.ciscospark.com) HTTP API wrapper written with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](http://aiohttp.readthedocs.io/en/stable/).

## Installation ##
```
pip install git+git://github.com/andriyko/[email protected]
```

## Features ##
- Built-in pagination support
- Automatic rate-limit handling
- Automatic refresh of an access token
- Optionally can read Spark credentials from your local environment
- Allows to register custom response handlers

## Usage and examples ##

`aiociscospark.APIClient` delegates:

- HTTP communication to `aiociscospark.HTTPClient`
- REST API stuff (building URLs, parameters, handling of responses, pagination etc) to `aiociscospark.ApiService`.

`aiociscospark.APIClient` owns a set of REST API services that are used to communicate with corresponding API resources:

```python
import aiociscospark
client = aiociscospark.get_client({'access_token': ''})
In [5]: for attr, svc in client.__dict__.items():
...: if isinstance(svc, aiociscospark.services.BaseApiService):
...: print(f'{svc.__class__.__name__:30} {svc.get_resource_url()}')
...:
...:
...:
ApiServiceContents https://api.ciscospark.com/v1/contents
ApiServiceLicenses https://api.ciscospark.com/v1/licenses
ApiServiceMessages https://api.ciscospark.com/v1/messages
ApiServiceOrganizations https://api.ciscospark.com/v1/organizations
ApiServicePeople https://api.ciscospark.com/v1/people
ApiServiceRoles https://api.ciscospark.com/v1/roles
ApiServiceRoomMemberships https://api.ciscospark.com/v1/memberships
ApiServiceRooms https://api.ciscospark.com/v1/rooms
ApiServiceTeamMemberships https://api.ciscospark.com/v1/team/memberships
ApiServiceTeams https://api.ciscospark.com/v1/teams
ApiServiceWebhooks https://api.ciscospark.com/v1/webhooks
```

For example, to get current user:

```python
import asyncio
event_loop = asyncio.get_event_loop()
me = event_loop.run_until_complete(client.people.me())
print(me['displayName'])
```

To perform request without wrappers and get `aiohttp.ClientResponse` object:

```python
url = client.people.get_resource_url('me') # no outbound HTTP request, just build URL
resp = event_loop.run_until_complete(client.http_client.get(url))
resp.__class__ # aiohttp.client_reqrep.ClientResponse
```

`aiociscospark.APIClient` expects credentials to be passed as a dictionary with at least `access_token` key. Other keys are optional: `client_id`, `client_secret`, `refresh_token`. Use `aiociscospark.Credentials` to read Spark credentials from your local environment.
It expects the following environment variables to be set: `CISCO_SPARK_ACCESS_TOKEN` (required), `CISCO_SPARK_REFRESH_TOKEN`, `CISCO_SPARK_CLIENT_ID`, `CISCO_SPARK_CLIENT_SECRET` (required only if you want to automatically refresh access token).

To register response handler:
```python
async def handle_unauthorized_response(resp):
# do what you need
pass

client.http_client.register_response_handler(401, handle_unauthorized_response)
```

## Running the tests ##

```bash
git clone [email protected]:andriyko/aiociscospark.git
cd aiociscospark
virtualenv -p python3 .venv
source .venv/bin/activate
pip install -r dev-requirements.txt
make test
```

## Contributing
First off, thanks for taking the time to contribute! :+1:
When contributing to this repository, please first discuss the change you wish to make via issue,
email, Spark (contact `andriyko`, you can find me in [#spark4dev](https://web.ciscospark.com/rooms/d2fde090-9d0c-11e5-aeed-2176fdcd8a58/chat) space), or any other method with the owners of this repository before making a change.

Please read [CONTRIBUTING.md](https://github.com/andriyko/aiociscospark/blob/master/.github/CONTRIBUTING.md) for the process for submitting pull requests.

## Authors

* [andriyko](https://github.com/andriyko)

See also the list of [contributors](CONTRIBUTORS.md) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.