Skip to main content

Top-level package for cards.

Project description

cards

image image Documentation Status image

Project task tracking / todo list

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.
  • Database location is flexible to the API, but the CLI hard codes it to a single user home directory.

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 │ state │ owner │ summary
╺━━━━┿━━━━━━━┿━━━━━━━┿━━━━━━━━━━━━━━╸
  1  │ todo  │       │ a todo
  2  │ todo  │ Brian │ another task
     ╵       ╵       ╵

$ cards update 1 -o Brian

$ cards finish 1

$ cards
  ID │ state │ owner │ summary
╺━━━━┿━━━━━━━┿━━━━━━━┿━━━━━━━━━━━━━━╸
  1  │ done  │ Brian │ a todo
  2  │ todo  │ Brian │ another task
     ╵       ╵       ╵

$ cards delete 1

$ cards
  ID │ state │ owner │ summary
╺━━━━┿━━━━━━━┿━━━━━━━┿━━━━━━━━━━━━━━╸
  2  │ todo  │ Brian │ another task
     ╵       ╵       ╵

$ cards --help
Usage: cards [OPTIONS] COMMAND [ARGS]...

  Cards is a small command line task tracking application.

Options:
  --help  Show this message and exit.

Commands:
  add      Add a card to db.
  config   List the path to the Cards db.
  count    Return number of cards in db.
  delete   Remove card in db with given id.
  finish   Set a card state to 'done'.
  list     List cards in db.
  start    Set a card state to 'in prog'.
  update   Modify a card in db with given id with new info.
  version  Return version of cards application

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cards-1.0.0.tar.gz (15.3 kB view hashes)

Uploaded Source

Built Distribution

cards-1.0.0-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page