Skip to main content

pivotaltracker is a Pythonic wrapper around the PivotalTracker API

Project description

Overview

This module provides a simple Pythonic interface to the PivotalTracker API. It also provides both a simple commandline interface to Pivotal.

Quickstart

This is the primary API for using Pivotal. First you simply create a client:

import pivotaltracker
client = pivotaltracker.Client(token="YOUR API TOKEN")

Now you can execute any of the API methods on that client. All method calls will return Python dictionaries. You can find detailed documentation in the docstrings for now, until I get the API docs created. Here’s a quick rundown in the meantime:

  • get_project (project_id)

  • get_all_projects (self)

  • get_story (project_id, story_id)

  • get_stories (project_id, query=None, limit=None, offset=None)

  • get_iterations (project_id, limit=None, offset=None)

  • get_done_iterations (project_id, limit=None, offset=None)

  • get_current_iterations (project_id, limit=None, offset=None)

  • get_backlog_iterations (project_id, limit=None, offset=None)

  • add_story (project_id, name, description, story_type, requested_by=None, estimate=None, current_state=None, labels=None)

  • update_story (project_id, story_id, name=None, description=None, requested_by=None, story_type=None, estimate=None, current_state=None, labels=None)

  • delete_story (project_id, story_id)

  • add_comment (project_id, story_id, text, author=None)

  • deliver_all_finished_stories (project_id)

Advanced

Commandline Tool

Simply run pt help on the commandline to see options. The first time you run the tool, it will walk you through creating your API key and setting up your configuration.

More documentation to come, later.

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

pivotaltracker-0.0.1.tar.gz (7.2 kB view details)

Uploaded Source

File details

Details for the file pivotaltracker-0.0.1.tar.gz.

File metadata

File hashes

Hashes for pivotaltracker-0.0.1.tar.gz
Algorithm Hash digest
SHA256 344a5d0c6e32b532e2eee7ed999340717412864aab959d77b73232631a4eb4d8
MD5 1301afda9a6717f5af3b66852e44f85d
BLAKE2b-256 86d5b33fe754585dca0b9cb18a063f7b5508e1f2d6922b668a4bf6c4cadaf77f

See more details on using hashes here.

Supported by

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