{
    "info": {
        "author": "OpenStack",
        "author_email": "openstack-dev@lists.openstack.org",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "Intended Audience :: Information Technology",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: Apache Software License",
            "Operating System :: POSIX :: Linux",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Topic :: Utilities"
        ],
        "description": "Boartty\n=======\n\nBoartty is a console-based interface to the Storyboard task-tracking\nsystem.\n\nAs compared to the web interface, the main advantages are:\n\n * Workflow -- the interface is designed to support a workflow similar\n   to reading network news or mail.  In particular, it is designed to\n   deal with a large number of stories across a large number of\n   projects.\n\n * Offline Use -- Boartty syncs information about changes in\n   subscribed projects to a local database.  All review operations are\n   performed against that database and then synced back to Storyboard.\n\n * Speed -- user actions modify locally cached content and need not\n   wait for server interaction.\n\nInstallation\n------------\n\nSource\n~~~~~~\n\nWhen installing from source, it is recommended (but not required) to\ninstall Boartty in a virtualenv.  To set one up::\n\n  virtualenv boartty-env\n  source boartty-env/bin/activate\n\nTo install the latest version from the cheeseshop::\n\n  pip install boartty\n\nTo install from a git checkout::\n\n  pip install .\n\nBoartty uses a YAML based configuration file that it looks for at\n``~/.boartty.yaml``.  Several sample configuration files are included.\nYou can find them in the examples/ directory of the\n`source distribution <https://git.openstack.org/cgit/openstack/boartty/tree/examples>`_\nor the share/boartty/examples directory after installation.\n\nSelect one of the sample config files, copy it to ~/.boartty.yaml and\nedit as necessary.  Search for ``CHANGEME`` to find parameters that\nneed to be supplied.  The sample config files are as follows:\n\n**minimal-boartty.yaml**\n  Only contains the parameters required for Boartty to actually run.\n\n**reference-boartty.yaml**\n  An exhaustive list of all supported options with examples.\n\n**openstack-boartty.yaml**\n  A configuration designed for use with OpenStack's installation of\n  Gerrit.\n\nYou will need a Storyboard authentication token which you can generate\nor retrieve by navigating to ``Profile``, then ``Tokens`` (the \"key\"\nicon), or visiting the `/#!/profile/tokens` URI in your Storyboard\ninstallation.  Issue a new token if you have not done so before, and\ngive it a sufficiently long lifetime (for example, one decade).  Copy\nand paste the resulting token in your ``~/.boartty.yaml`` file.\n\nThe config file is designed to support multiple Storyboard instances.\nThe first one is used by default, but others can be specified by\nsupplying the name on the command line.\n\nUsage\n-----\n\nAfter installing Boartty, you should be able to run it by invoking\n``boartty``.  If you installed it in a virtualenv, you can invoke it\nwithout activating the virtualenv with ``/path/to/venv/bin/boartty``\nwhich you may wish to add to your shell aliases.  Use ``boartty\n--help`` to see a list of command line options available.\n\nOnce Boartty is running, you will need to start by subscribing to some\nprojects.  Use 'L' to list all of the projects and then 's' to\nsubscribe to the ones you are interested in.  Hit 'L' again to shrink\nthe list to your subscribed projects.\n\nIn general, pressing the F1 key will show help text on any screen, and\nESC will take you to the previous screen.\n\nBoartty works seamlessly offline or online.  All of the actions that\nit performs are first recorded in a local database (in\n``~/.boartty.db`` by default), and are then transmitted to Storyboard.\nIf Boartty is unable to contact Storyboard for any reason, it will\ncontinue to operate against the local database, and once it\nre-establishes contact, it will process any pending changes.\n\nThe status bar at the top of the screen displays the current number of\noutstanding tasks that Boartty must perform in order to be fully up to\ndate.  Some of these tasks are more complicated than others, and some\nof them will end up creating new tasks (for instance, one task may be\nto search for new stories in a project which will then produce 5 new\ntasks if there are 5 new stories).\n\nIf Boartty is offline, it will so indicate in the status bar.  It will\nretry requests if needed, and will switch between offline and online\nmode automatically.\n\nIf Boartty encounters an error, this will also be indicated in the\nstatus bar.  You may wish to examine ~/.boartty.log to see what the\nerror was.  In many cases, Boartty can continue after encountering an\nerror.  The error flag will be cleared when you leave the current\nscreen.\n\nTo select text (e.g., to copy to the clipboard), hold Shift while\nselecting the text.\n\nTerminal Integration\n--------------------\n\nIf you use rxvt-unicode, you can add something like the following to\n``.Xresources`` to make Storyboard URLs that are displayed in your\nterminal (perhaps in an email or irc client) clickable links that open\nin Boartty::\n\n  URxvt.perl-ext:           default,matcher\n  URxvt.url-launcher:       sensible-browser\n  URxvt.keysym.C-Delete:    perl:matcher:last\n  URxvt.keysym.M-Delete:    perl:matcher:list\n  URxvt.matcher.button:     1\n  URxvt.matcher.pattern.1:  https:\\/\\/storyboard.example.org/#!/story/(\\\\d+)[\\w]*\n  URxvt.matcher.launcher.1: boartty --open $0\n\nYou will want to adjust the pattern to match the Storyboard site you\nare interested in; multiple patterns may be added as needed.\n\nContributing\n------------\n\nFor information on how to contribute to Boartty, please see the\ncontents of the CONTRIBUTING.rst file.\n\nBugs\n----\n\nBugs are handled at: https://storyboard.openstack.org/",
        "description_content_type": null,
        "docs_url": null,
        "download_url": null,
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://www.openstack.org/",
        "keywords": "storyboard console urwid",
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "boartty",
        "package_url": "https://pypi.org/project/boartty/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/boartty/",
        "project_urls": {
            "Homepage": "http://www.openstack.org/"
        },
        "release_url": "https://pypi.org/project/boartty/0.0.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Boardtty is a console-based interface to Storyboard.",
        "version": "0.0.0"
    },
    "last_serial": 2433320,
    "releases": {
        "0.0.0": []
    },
    "urls": []
}