Skip to content

Latest commit

 

History

History

README.md

Example Scripts

In this directory are some example scripts to access the ScrumDo API.

local_settings.example
Example configuration file for the other scripts.

emc_trello_import.py Sample script for importing a customer's data.

export_attachments_comments.py
Example script to export comments and attachments.

import_util.py
Utility methods for importing a customer's data.

scrumdo_example.py
Example of some of the API calls.

story_queue_example.py Shows how to manually add a card to the ScrumDo story queue.

This is a simple python script capable of accessing the ScrumDo API via HTTP Basic authentication.

These are released under the MIT License and are suitable as either a reference or a starting point for your applications.

Usage

  1. Optional: First, get set up a python virtual environment

    virtualenv env

  2. Set up the requirements

    pip install -r requirements.txt

  3. Create a local settings file.

    cp local_settings.example local_settings.py

  4. Edit local_settings.py to include your authentication information

  5. Run the scripts

    python scrumdo_example.py

Example Output

ScrumDo LLC	scrumdo
	ScrumDo	scrumdo-web
			Backlog None to None
				99 Stories, 376 Points, 6 Completed tasks
			Iteration 1 2010-11-13 to 2010-11-20
				0 Stories, 0 Points, 0 Completed tasks
			Iteration 2 2010-11-20 to 2010-11-28
				0 Stories, 0 Points, 0 Completed tasks
			Iteration 3 2010-11-27 to 2010-12-04
				0 Stories, 0 Points, 0 Completed tasks
			Iteration 4 2010-12-04 to 2010-12-11
				1 Stories, 0 Points, 0 Completed tasks
			Iteration 5 2010-12-12 to 2011-01-05
				0 Stories, 0 Points, 0 Completed tasks
			Iteration 6 2011-01-05 to 2011-01-14
				0 Stories, 0 Points, 0 Completed tasks
			Iteration 7 2011-01-15 to 2011-01-29
				0 Stories, 0 Points, 0 Completed tasks

MIT License

Copyright (c) 2015 ScrumDo LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.