Skip to main content

Python wrapper for Speedcurve API(https://api.speedcurve.com/)

Project description

https://travis-ci.org/itsmemattchung/speedcurve.py.svg?branch=master

A python wrapper for around the SpeedCurve API v1. Heavily influenced by github3.py

Full documentation

Example Use

from speedcurve import SpeedCurve

sc = SpeedCurve(api_key='your-api-key-here')
# Get all sites for a user
sites = sc.sites()

# Get trends and all tests for a URL
urls = sc.urls()

# Get trends and chrome tests for a URL
urls = sc.url(browser='14419')

# Get a test
test = sc.test(id='140317_BA_3W8')

# Get all the notes for the main site
notes = sc.notes()

# Add a note. Timestamp defaults to now()
note = sc.create_note(
    note="Cleared CDN Cache",
    detail="Testing origin response times"
)

# Get latest deployment
latest_deployment = sc.get_latest_deployment()

# Get a deployment specified by id
deployment = sc.get_deployment(id=16627)

# Add a deployment to default Site for API key
sc.add_deployment(
    note="Code deployment",
    detail="Triggered a deployment to test session capability"
)

# Add a deployment and trigger round of testing specified by site-id
sc.add_deployment(
    site_id=123,
    note="Code deployment",
    detail="Triggered a deployment to test origin response times."""
)

Testing

Run pip install -r dev-requirements.txt. You can then execute tox.

Contributing

  1. Fork the repository and make changes (add yourself to AUTHORS.rst)

  2. Test changes locally by running tox

  3. Squash changes into a single commit

  4. Create pull request to develop branch

Note:

Travis-CI will FAIL if there isn’t 100% test coverage. Please include a test with your change.

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

speedcurve.py-0.2.0.tar.gz (4.6 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