GitHub - Clever/clever-python: Clever Python bindings

Notice

This repo is no longer maintained by Clever. We provide the Swagger definitions at https://github.com/Clever/swagger-api.

Clever - the Python library for the Clever API

API Documentation

View more detailed documentation here

Requirements.

Python 2.7 and 3.4+

Installation

From PyPi:

Or from source:

    $ python setup.py install

Then import the package:

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Note: This is hard coded for demo purposes only. Keep your access tokens secret!
# https://dev.clever.com/docs/security#section-security-best-practices

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))

try:
    api_response = api_instance.get_students()
    for student in api_response.data:
        pprint(student.data.id)
except ApiException as e:
    print("Exception when calling DataApi->get_students: %s\n" % e)

Updating the Library

Git clone swagger-codegen (https://github.com/swagger-api/swagger-codegen)
Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
Run this command in the swagger-codegen repo

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v2.1-client.yml -l python -o $PATH_TO_THIS_REPO --additional-properties packageVersion=$VERSION

Run make override to copy over the override files
Update the CHANGELOG.md with the changes!

Development

Dependencies

Testing

Publishing

Run make publish to publish a new version of the library.

In order to publish to PyPI you will need a .pypirc file in your $HOME directory with the following contents:

[distutils]
index-servers =
    pypi

[pypi]
username: ****
password: ****

The username and password are in 1Password for Teams under PyPI.