{
    "info": {
        "author": "Jason Diller",
        "author_email": "jdiller@pagerduty.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Sprint Stats\nThis is a python script you can run after a completed sprint to gather some statistics about that sprint from JIRA.\n\n## License\n[Apache 2](http://www.apache.org/licenses/LICENSE-2.0)\n\n## Contributing\nFeel free to fork the repository and submit any useful changes back as via a pull request.\n\n## Installation\nRun `sudo -H pip install pd-sprintstats`\n\n## Usage\n\n### Prerequisites\nTo use the script, you need a few things.\n* The url for a valid JIRA instance (e.g. https://company.atlassian.net)\n* A user with access to that instance (e.g. jdiller)\n* That user's password.\n\nThe easiest thing to do is make a config file and specify these things there using the following format:\n\n    [default]\n    user=YOUR_USER\n    server=https://pagerduty.atlassian.net/\n    password=YOUR_PASSWORD\n\nThe script will look for the config file in the following locations (if found, the higher item on this list takes precedence):\n* In the location specified in the command line with the `--config` or `-c` option.\n* A file named `config.cfg` in the current working directory.\n* A file named `.sprintstats.cfg` in the current user's home directory *Recommended*\n* `/usr/local/etc/sprintstats.cfg`\n* `/etc/sprintstats.cfg`\n\nAlternatively, you can specify the credentials on the command line. See the help-text.\n\n###Run your sprint stats\nOnce you've got your credentials set up, you can process some stats!\n\n    $ sprintstats -b \"My Board\" -t \"My Sprint\" --project \"AProject\"\n\n    Completed Issues\n    ================\n    MB-2      As a user I can print my schedule\n    MB-3      As a user I can export my schedule as a PDF file\n    MB-4      As an admin I can give users permission to print or export schedules\n\n    Incomplete Issues\n    =================\n    MB-9      As a user I can export my schedule as a CSV file\n    MB-14     As a user I can import a schedule from a CSV File\n\n    Cycle Time Statistics\n    =====================\n    cycle_time_stddev   :12.1537766029\n    velocity            :44.0\n    min_cycle_time      :4\n    average_cycle_time  :16.0\n    max_cycle_time      :38\n\n\n### Scripts and Options\n\n    $./sprintstats -h\n    usage: sprintstats [-h] [--user USER] [--password PASSWORD] [-P]\n                       [--list-boards] [--server SERVER] [--board [BOARD]]\n                       [--sprint [SPRINT]] [--project PROJECT] [--config CONFIG]\n                       [--json]\n\n    Gather some statistics about a JIRA sprint\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --user USER, -u USER  The JIRA user name to used for auth. If omitted the\n                            current user name will be used.\n      --password PASSWORD, -p PASSWORD\n                            The JIRA password to be used for auth. If omitted you\n                            will be prompted.\n      -P                    Prompt for password.\n      --list-boards, -l     When supplied, a list of RapidBoards and their\n                            associated IDs are displayed\n      --server SERVER, -s SERVER\n      --board [BOARD], -b [BOARD]\n                            The name or id of the rapidboard that houses the\n                            sprint for which you want to gather stats.\n      --sprint [SPRINT], -t [SPRINT]\n                            The name of the sprint on which to produce the stats\n      --project PROJECT, -r PROJECT\n                            The project for which to gather backlog stats\n      --config CONFIG, -c CONFIG\n                            The path to a config file containing jira server\n                            and/or credentials (See README.md)\n      --json, -j            Produce output in JSON format\n\n\n##Wiki-fy the results\nIf you want to create a sprint review wiki page, you can pipe the json output from the `sprintstats` script into the `wikifysprint` script.\n\n    usage: wikifysprint [-h] [--user USER] [--password PASSWORD] [-P]\n                        [--server SERVER] [--config CONFIG] [--space SPACE]\n                        [--parent [PARENT]] [--title TITLE]\n\n    Create a new Confluence page with sprint stats\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --user USER, -u USER  The Confluence user name to used for auth. If omitted\n                            the current user name will be used.\n      --password PASSWORD, -p PASSWORD\n                            The Confluence password to be used for auth.\n      -P                    Prompt for password.\n      --server SERVER, -s SERVER\n      --config CONFIG, -c CONFIG\n                            The path to a config file containing Confluence server\n                            and/or credentials (See README.md)\n      --space SPACE, -e SPACE\n                            The space that will contain the created/updated page\n      --parent [PARENT], -r [PARENT]\n                            The parent of the created/updated page.\n      --title TITLE, -t TITLE\n                            The title of the created/updated page\n\nThis script will use the same credentials files in the same precedence as the statistics gathering sscript.\n\n###Using the two together\n    sprintstats -b \"My Board\" -t \"My Sprint\" -r \"AProject\" --json | wikifysprint -e \"Team Space\" -t \"My Sprint Review\"\n\n##Wiki-fy Trello Boards\nWe use Trello boards to conduct retros, but want to capture the state of the board in our wiki. An additional script can be used to take a snapshot of the state of the trello board and convert it into a wiki page. It uses many of the same options as the sprint review wiki script.\n\n    usage: trello2wiki [-h] [--user USER] [--password PASSWORD] [--board BOARD]\n                       [-P] [--server SERVER] [--config CONFIG] [--space SPACE]\n                       [--parent [PARENT]] [--title TITLE]\n                       [--trello-key TRELLO_KEY] [--trello-secret TRELLO_SECRET]\n                       [--trello-token TRELLO_TOKEN]\n                       [--trello-token-secret TRELLO_TOKEN_SECRET]\n\n    Create a new Confluence page with the contents of a trello board\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --user USER, -u USER  The Confluence user name to used for auth. If omitted\n                            the current user name will be used.\n      --password PASSWORD, -p PASSWORD\n                            The Confluence password to be used for auth.\n      --board BOARD, -b BOARD\n                            The name or id of the trello board to convert to a\n                            wiki page\n      -P                    Prompt for confluence password.\n      --server SERVER, -s SERVER\n      --config CONFIG, -c CONFIG\n                            The path to a config file containing Confluence server\n                            and/or Trello credentials (See README.md)\n      --space SPACE, -e SPACE\n                            The space that will contain the created/updated page\n      --parent [PARENT], -r [PARENT]\n                            The parent of the created page. (Ignored if the page\n                            already exists)\n      --title TITLE, -t TITLE\n                            The title of the created/updated page\n      --trello-key TRELLO_KEY\n                            API Key for Trello Authentication\n      --trello-secret TRELLO_SECRET\n                            API Secret for Trello Authentication\n      --trello-token TRELLO_TOKEN\n                            OAuth Token for Trello Authentication\n      --trello-token-secret TRELLO_TOKEN_SECRET\n                            OAuth Token Secret for Trello Authentication\n\n## Trello Authentication\nYou will need trello authentication tokens to use this script. They can be specified on the command line or added to one of the config files above using the following key/value pairs:\n\n    trello_key=REPLACE_WITH_YOUR_API_KEY\n    trello_secret=REPLACE_WITH_YOUR_API_SECRET\n    trello_token=RELPLACE_WITH_OAUTH_TOKEN\n    trello_token_secret=REPLACE_WITH_OAUTH_TOKEN_SECRET\n\nYou can find the information for how to obtain the above tokens [in the Trello API documentation](https://trello.com/docs/gettingstarted/index.html#getting-an-application-key)\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "UNKNOWN",
        "keywords": null,
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "pd-sprintstats",
        "package_url": "https://pypi.org/project/pd-sprintstats/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/pd-sprintstats/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "UNKNOWN"
        },
        "release_url": "https://pypi.org/project/pd-sprintstats/3.2.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Gathers some statistics for a sprint from JIRA",
        "version": "3.2.2"
    },
    "last_serial": 1589611,
    "releases": {
        "2.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6f502ffb03c6a7ec57c04fe6feb17bfc",
                    "sha256": "0c2e1cf8bab650b24284cd00ecb0fffa3341d9b868b35eeb7510708fd0811738"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-2.10a.tar.gz",
                "has_sig": false,
                "md5_digest": "6f502ffb03c6a7ec57c04fe6feb17bfc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8300,
                "upload_time": "2015-04-30T17:56:04",
                "url": "https://files.pythonhosted.org/packages/d8/ca/92ea1091d1c0b9726d1f297cd3a308df944cb53c1819289ee85387cf26f4/pd-sprintstats-2.10a.tar.gz"
            }
        ],
        "2.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d502eb39f44a00c7a2b7d2065e243a7d",
                    "sha256": "4b7dc12b4670f7f140d85595af04669bc92c6e6d5e5698a132d7e46b4c5b3ecb"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-2.08.tar.gz",
                "has_sig": false,
                "md5_digest": "d502eb39f44a00c7a2b7d2065e243a7d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7533,
                "upload_time": "2015-04-24T15:25:24",
                "url": "https://files.pythonhosted.org/packages/90/27/8adecc79c40d449fdb3318e45e62e5a6bb0762992fd15026950def8ab086/pd-sprintstats-2.08.tar.gz"
            }
        ],
        "3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b16bf5efe4ca610c95943a0b415127c9",
                    "sha256": "e7d263519d95e95753613a4d8d17fc613e4f5a5e5e7b1fe8a8f700fba9c86838"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b16bf5efe4ca610c95943a0b415127c9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8298,
                "upload_time": "2015-05-01T12:50:35",
                "url": "https://files.pythonhosted.org/packages/c8/87/e402e3cf98ad9b86a80941bad918aa9c34352a5a60315b3d07c3e7a4ff4e/pd-sprintstats-3.0.tar.gz"
            }
        ],
        "3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f2680ffb6838ca84e75ec33a3b556b6e",
                    "sha256": "06b3159ee928982f906cb345108c8faeef6463dffcb1f875b34d42dd02b98cc2"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f2680ffb6838ca84e75ec33a3b556b6e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8893,
                "upload_time": "2015-05-05T19:19:09",
                "url": "https://files.pythonhosted.org/packages/87/70/2227e86ea81f1ff3312ebfb6ccf9534d31a823b8cebf30b0ea844d6dca29/pd-sprintstats-3.1.tar.gz"
            }
        ],
        "3.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1706009109b5310688fd17d2972cc727",
                    "sha256": "ce4729e0018327fd0c01fdab9c7d816a0593813c7ace5bf63481c51ef3a781ce"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-3.2.tar.gz",
                "has_sig": false,
                "md5_digest": "1706009109b5310688fd17d2972cc727",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8945,
                "upload_time": "2015-05-14T21:31:36",
                "url": "https://files.pythonhosted.org/packages/bb/72/127a3f1b8b7e5e0bf16bed237673f40539130e29b8a1ac34013972eede52/pd-sprintstats-3.2.tar.gz"
            }
        ],
        "3.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5493bf51249e8d4010c768663f519d3b",
                    "sha256": "67cea896e9a32ef1d39f6f4870746533038e736c863c2ff1f3d495f4fdf4da5f"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-3.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "5493bf51249e8d4010c768663f519d3b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8970,
                "upload_time": "2015-05-14T21:50:36",
                "url": "https://files.pythonhosted.org/packages/91/d1/41b5ce92abfc8b8b6860e2c4da31731980772cfcd0133815e3e198950215/pd-sprintstats-3.2.1.tar.gz"
            }
        ],
        "3.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a001653920449b63049e9d89b6b2efe8",
                    "sha256": "e5511c2635f5eb1585b709b0389608df55d91245c0f73ee8cc61abf6ff24f1e0"
                },
                "downloads": -1,
                "filename": "pd-sprintstats-3.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "a001653920449b63049e9d89b6b2efe8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8981,
                "upload_time": "2015-06-12T13:29:07",
                "url": "https://files.pythonhosted.org/packages/cc/1b/a983e4545874f0d15c455a60be3232d75d1848f4ce876bacbcd97074de3a/pd-sprintstats-3.2.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a001653920449b63049e9d89b6b2efe8",
                "sha256": "e5511c2635f5eb1585b709b0389608df55d91245c0f73ee8cc61abf6ff24f1e0"
            },
            "downloads": -1,
            "filename": "pd-sprintstats-3.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a001653920449b63049e9d89b6b2efe8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8981,
            "upload_time": "2015-06-12T13:29:07",
            "url": "https://files.pythonhosted.org/packages/cc/1b/a983e4545874f0d15c455a60be3232d75d1848f4ce876bacbcd97074de3a/pd-sprintstats-3.2.2.tar.gz"
        }
    ]
}