Skip to main content

A simple Python wrapper for the TidyClub API

Project description

Welcome to pytidyclub!

pytidyclub is a simple Python wrapper for the TidyClub API.

https://travis-ci.org/KyeRussell/pytidyclub.svg?branch=master https://coveralls.io/repos/KyeRussell/pytidyclub/badge.svg

TidyClub is a powerful online tool that removes a lot of hassle from the management of your club or association. Unfortunately, TidyClub doesn’t do everything, but they provide an API which you can use to extend it. pytidyclub is a Python wrapper for this API, which makes creating Python projects that interface with the TidyClub API easier.

pytidyclub is not a complete implementation of the TidyClub _API.

Installing

You can install pytidyclub with pip:

pip install pytidyclub

Example

from pytidyclub import pytidyclub

club = pytidyclub.Club(
    slug = default,
    client_id = "12345J",
    client_secret = "54321F"
)

# Authenticate as a user.
print club.auth_authcode_get_url("https://sso.example.com/oauth/tidyclub/callback")
club.auth_authcode_exchange_code("555555", "https://sso.example.com/oauth/tidyclub/callback")

# Get all contacts.
contacts = club.get_contacts()

# Search for contacts
contacts = club.get_contacts("Kye Russell")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytidyclub-0.0.8.tar.gz (5.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page