Metadata-Version: 1.1
Name: rdial
Version: 1.1.0
Summary: Simple time tracking for simple people
Home-page: https://github.com/JNRowe/rdial
Author: James Rowe
Author-email: jnrowe@gmail.com
License: GPL-3
Project-URL: Contributors, https://github.com/JNRowe/rdial/contributors/
Project-URL: Documentation, https://rdial.readthedocs.io/
Project-URL: Git repository, https://github.com/JNRowe/rdial/
Project-URL: Issue tracker, https://github.com/JNRowe/rdial/issues/
Description: rdial - Simple time tracking for simple people
        ==============================================
        
        |status| |travis| |coveralls| |pypi| |pyvers| |readthedocs| |develop|
        
        ``rdial`` is a simple way to track the time you spend on tasks.  It tracks the
        name of a task, its start time, its duration and optionally a message… nothing
        more.
        
        ``rdial`` is released under the `GPL v3`_ license.
        
        Requirements
        ------------
        
        ``rdial``’s mandatory dependencies outside of the standard library are:
        
        * click_ ≥ 7.0
        * jnrbase_ ``[colour,iso_8601]`` ≥ 1.0.0
        * tabulate_
        
        It should work with Python_ version 3.6, or newer.  If ``rdial`` doesn’t work
        with the version of Python you have installed, file an issue_ and I’ll
        endeavour to fix it.
        
        The package has been tested on many UNIX-like systems, including Linux and OS
        X, but it may work fine on other systems too.
        
        To run the tests you’ll need pytest_.  Once you have pytest_ installed you can
        run the tests with the following commands:
        
        .. code-block:: console
        
            $ pytest tests
        
        Database
        --------
        
        The database is just a directory of simple CSV files, making it useful to use
        and abuse in other applications.  A sample database could be a file named
        ``task.csv`` with the following contents::
        
            start,delta,message
            2011-05-04T08:00:00Z,PT01H00M00S,working on issue 4
            2011-05-04T09:30:00Z,,
        
        and a ``task2.csv`` file with the following contents::
        
            start,delta,message
            2011-05-04T09:15:00Z,PT00H15M00S,
        
        The CSV files contain the following fields:
        
        1. Start time expressed in UTC
        2. Task duration
        3. An optional message associated with the event
        
        The start time and duration fields are given as `ISO 8601`_ formatted strings.
        
        If a line does not contain a duration entry, then the task is considered to be
        running.
        
        Interface
        ---------
        
        .. code-block:: console
        
            $ rdial start <task_name>
            $ rdial stop
            $ rdial report
            +-------+----------------+
            | task  | time           |
            +-------+----------------+
            | task  |        1:00:00 |
            | task2 | 1 day, 0:15:00 |
            +-------+----------------+
        
        Contributors
        ------------
        
        I’d like to thank the following people who have contributed to ``rdial``.
        
        Patches
        '''''''
        
        * Nathan McGregor
        
        Bug reports
        '''''''''''
        
        * Delphine Beauchemin
        * Henry Richards
        * James Gaffney
        * Ryan Sutton
        * Stephen Thorne
        
        Ideas
        '''''
        
        * Adam Baxter
        * Kevin Simmons
        * Thomas Gallagher
        
        If I’ve forgotten to include your name I wholeheartedly apologise.  Just drop me
        a mail_ and I’ll update the list!
        
        Bugs
        ----
        
        If you find any problems, bugs or just have a question about this package either
        file an issue_ or drop me a mail_.
        
        If you’ve found a bug please try to include a minimal testcase that reproduces
        the problem, or even better a patch that fixes it!
        
        .. _GPL v3: http://www.gnu.org/licenses/
        .. _click: https://pypi.org/project/click/
        .. _jnrbase: https://pypi.org/project/jnrbase/
        .. _tabulate: https://pypi.org/project/tabulate/
        .. _Python: http://www.python.org/
        .. _issue: https://github.com/JNRowe/rdial/issues
        .. _pytest: https://pypi.org/projects/pytest/
        .. _ISO 8601:  https://en.wikipedia.org/wiki/Iso8601
        .. _mail: jnrowe@gmail.com
        
        .. |travis| image:: https://img.shields.io/travis/JNRowe/rdial.png
           :target: https://travis-ci.org/JNRowe/rdial
           :alt: Test state on master
        
        .. |develop| image:: https://img.shields.io/github/commits-since/JNRowe/rdial/latest.png
           :target: https://github.com/JNRowe/rdial
           :alt: Recent developments
        
        .. |pyvers| image:: https://img.shields.io/pypi/pyversions/rdial.png
           :alt: Supported Python versions
        
        .. |status| image:: https://img.shields.io/pypi/status/rdial.png
           :alt: Development status
        
        .. |coveralls| image:: https://img.shields.io/coveralls/github/JNRowe/rdial/master.png
           :target: https://coveralls.io/repos/JNRowe/rdial
           :alt: Coverage state on master
        
        .. |pypi| image:: https://img.shields.io/pypi/v/rdial.png
           :target: https://pypi.org/project/rdial/
           :alt: Current PyPI release
        
        .. |readthedocs| image:: https://img.shields.io/readthedocs/rdial/stable.png
           :target: https://rdial.readthedocs.io/
           :alt: Documentation
        
Keywords: timetracking,task,report
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Office/Business
Classifier: Topic :: Office/Business :: News/Diary
Classifier: Topic :: Office/Business :: Scheduling
Classifier: Topic :: Other/Nonlisted Topic
Classifier: Topic :: Utilities
