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)

Release Notes

  • 0.0.2 added bug submission to the tool

  • 0.0.1 original Client API object, very basic commandline tool (only submits chores)

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.2.tar.gz (8.3 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for pivotaltracker-0.0.2.tar.gz
Algorithm Hash digest
SHA256 dabf5eac03afccc02a785234451eb630dee51643f3a6efe29873094852cefdd3
MD5 145d351b18ef97a4444dec7a8b25e148
BLAKE2b-256 b0ecc1de3dd0adc889b4f830e633aa935a9d9536747daca3c7a05971a1bc09df

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