Metadata-Version: 1.2
Name: cards
Version: 0.2.3
Summary: Project task tracking / todo list.
Home-page: https://github.com/okken/cards
Author: Brian Okken
Author-email: brian@pythontesting.net
License: MIT
Description: 
        =====
        cards
        =====
        
        
        .. image:: https://img.shields.io/pypi/v/cards.svg
                :target: https://pypi.python.org/pypi/cards
        
        .. image:: https://img.shields.io/travis/okken/cards.svg
                :target: https://travis-ci.org/okken/cards
        
        .. image:: https://ci.appveyor.com/api/projects/status/hk18x9ovqv3d7kpw?svg=true
            :target: https://ci.appveyor.com/project/okken/cards
        
        .. image:: https://readthedocs.org/projects/cards-project/badge/?version=latest
                :target: https://cards-project.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://codecov.io/gh/okken/cards/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/okken/cards
        
        Project task tracking / todo list (in progress)
        
        Initial Goals of the project
        ----------------------------
        
        - Create a command line application that can be used to track the status
          of a multi-person project.
        - Explore the problems inherent in all applications regarding usability,
          testing, packaging, deployment, etc.
        
        Rough Current Status
        --------------------
        
        - A "usable" API and CLI. The CLI workflow needs work.
        - Database location is flexible to the API, but the CLI hardcodes it to a
          single user home directory.
        
        Short Term TODO items
        ---------------------
        
        - Remove presentation from most of the automated tests.
          It's a pain when the presentation changes.
        - Add tags, due dates, history, ... maybe.
        - Maintain 100% code coverage.
        - Switch README to markdown
        - Switch to flit for packaging
        - add black
        - add pre-commit hooks with flake8 and black and testing
        
        
        Long Term TODO items
        --------------------
        
        - Split off the CLI to a separate package, maybe
        - Create a REST API and multi-user capability so that multiple people can
          connect to one database.
        - Create alternative front ends. For example:
          - remote CLI
          - Flask
          - Other web frameworks
        - Deploy some version to a cloud based solution.
        - Continue to explore all of the troubling difficult points in blog posts and
          podcast episodes.
        - Change the history.md document into something more sane. Anyone know a good
          way to keep a change log that is relevant but not difficult to maintain?
        - Keep it a reasonably simple project that is a good example of whatever the
          Python community generally agrees is ok practices.
        
        More info
        ---------
        
        This is a demo application being built in conjunction with
        the `Test & Code podcast <http://testandcode.com>`__.
        
        We'll be building up this application, and testing it, and adding
        functionality, while discussing software testing and development
        practices.
        
        Follow along, starting with `episode 37 <http://testandcode.com/37>`__.
        
        
        * Free software: MIT license
        * Documentation: https://cards-project.readthedocs.io.
        
        
        Usage
        -----
        
        See usage_ page for details, but here's a demo of how it works::
        
            $ cards add 'a todo'
        
            $ cards add -o Brian 'another task'
        
            $ cards list
              ID      owner  done summary
              --      -----  ---- -------
               1                  a todo
               2      Brian       another task
        
            $ cards update 1 -o Brian
        
            $ cards update 1 --done True
        
            $ cards
              ID      owner  done summary
              --      -----  ---- -------
               1      Brian    x  a todo
               2      Brian       another task
        
            $ cards delete 1
        
            $ cards
              ID      owner  done summary
              --      -----  ---- -------
               2      Brian       another task
        
            $ cards --help
            Usage: cards [OPTIONS] COMMAND [ARGS]...
        
              Run the cards application.
        
            Options:
              --version   Show the version and exit.
              -h, --help  Show this message and exit.
        
            Commands:
              add     add a card
              count   list count
              delete  delete a card
              list    list cards
              update  update card
        
        
        .. _usage: https://cards-project.readthedocs.io/en/latest/usage/
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
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 :: Implementation :: CPython
Requires-Python: >=3.6.0
