Skip to main content

Python Library for Spurwing API

Project description

Spurwing API Python Library

Lightweight Python library for Spurwing's API.

Spurwing's API makes it easy to add robust scheduling and booking to your application. We power millions of appointment bookings for thousands of companies, from marketplaces to SaaS & healthcare.

Account

To use this API you need to obtain API credentials by signin up here: https://spurwing.io/

On your dashboard you will have the "API Info" page with your API key and Provider ID.

  • API Key: This is your private API Key used for private and authorized operations.

  • Provider ID: This is your public calendar identifier.

Security Warning: Never expose your API Key in front-end javascript code. All implementations that require your API Key should be handled by your back-end in a secure environment.

Usage

You can use pip to install the library: pip install spurwing

If you use another method, make sure to install the dependencies: pip install -r requirements.txt

You can use it as such:

from spurwing import Client as sp

PID = 'your_provider_id';
KEY = 'your_api_key';

A = sp.list_appointments(KEY, 1000, 0, PID)

Documentation

The currently implemented API functions and features are:

  • get_appointment_types
  • get_days_available
  • get_slots_available
  • complete_booking
  • list_appointments
  • delete_appointment

For additional demos and use cases have a look under spurwing/test_api.py.

Spurwing's REST API Reference and Docs: https://docs.spurwing.io/

Testing

To run our predefined unit tests use the spurwing/test_api.py script. You also need to rename the config.sample.py file to config.py and enter your credentials (provider id and api key). You can optionally use PyTest or another framework.

Support

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

Spurwing-1.0.5.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Spurwing-1.0.5-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file Spurwing-1.0.5.tar.gz.

File metadata

  • Download URL: Spurwing-1.0.5.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for Spurwing-1.0.5.tar.gz
Algorithm Hash digest
SHA256 f916e7f973234449aa2fd8e29d3341d8f5b6217bf9952aeb31fd6fe368443d49
MD5 08544a9ce2b743ce552bd75199b4ae87
BLAKE2b-256 bb0879790b881633e792a10d859538aaeb6ce1a382be1325dcb2c075f392dcab

See more details on using hashes here.

File details

Details for the file Spurwing-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: Spurwing-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for Spurwing-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cb9008f0a66a0d4534713f094ef7fbd528d4b7e96a9ebaa6f605b912e0bb284c
MD5 0fc2a1be68796194ec691f5eaacb2170
BLAKE2b-256 199a343c5259a6f55a0b64ba77b2d3337b8d848f8f4bd9e66410e565f3cef2b0

See more details on using hashes here.

Supported by

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