This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
git-todo
========

A small script to manage TODO-entries inside a git repository. A personal
project, with sparse documentation. Try ``git-todo --help`` to get detailed
information about each command.


Integration
-----------

When ``git-todo`` is found via ``$PATH``, git will find it if you run ``git
todo``. This is useful when using it from inside a `repl
<https: github.com="" mbr="" repl="">`_.


Examples
--------

Initializing a new TODO list and edit entries:

.. code-block:: sh

git todo new
git todo edit

A valid list:

.. code-block:: txt

x Do dishes.
* Cleanup apartment.
* Achieve world domination.
! Call mum on her birthday.

Running ``git todo``, which is a shortcut for ``git todo list``, yields the
following (colorful) results:

.. code-block:: sh

git todo

.. code-block:: txt

! Call mum on her birthday.
* Cleanup apartment.
* Achieve world domination.
x Do dishes.

Note that completed tasks (``x``) have been moved to the end and important
(``!``) tasks to the front.


Headings
~~~~~~~~

Headings can be added in a format similar to `ReStructured Text
<http: docutils.sourceforge.net="" docs="" user="" rst="" quickref.html#section-<br="">structure>`_.

.. code-block:: txt

Chores
------
x Do dishes.
* Cleanup apartment.
! Call mum on her birthday.

Project X
---------
! Get started.
* Achieve world domination.
x Dream Big.


History
~~~~~~~

TODOs are kepy in a regular git branch that contains a single file:

.. code-block:: sh

git log --format=oneline todo

.. code-block:: txt

29e941f005de2fa998939b674ed7c4be47a93649 Updated TODO
8330b8167b4393f07ccc0f712301f0630f470a9e Initial commit for TODO branch
Release History

Release History

0.2.dev1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting