Giter VIP home page Giter VIP logo

plume's Introduction

Plume

This little Python 3 tool lets you manage a simple console-based todo list, which also doubles up as a rudimentary bugtracker. This tool is intended for small prototype projects with little infrastructure in place, with typically only one or two developers. Larger code bases will prefer a full-fledged solution.

Features

  • non-intrusive: the tool generates a single .plume file in the root directory of your project, and can then be run from any location inside your project;

  • simple: the commands are straightforward, and we use JSON to store a human-readable data file, should you ever need to delve into it;

  • good-looking: colors are extensively used in order to give a quick overview of the bugs which most need addressing, and those which have been fixed;

  • easy to tweak: the main script is a little over 200 lines long and can easily be extended;

  • portable: all major operating systems are supported;

Install

It is recommended to symlink the script to a location on your PATH, so that you can just call plume. This can easily be done on Windows as well, at least on NTFS file systems.

Usage

First create a .plume file in your project's root folder by running the tool once in it with no arguments. From this point on you can run the tool from any folder inside your project, it will autodetect the existing data file.

You can now add bugs or desired features (issues) easily using --add:

$ plume --add [feature/minor/major/etc] "description"

The new issue is then assigned a unique number which identifies it. The set of priorities available is by default feature, trivial, minor, major, and critical, but other ones can be easily added to the script.

If you made a typo, or otherwise need to change the description, you can use the --edit command, which takes the issue number:

$ plume --edit 14 "amended description for issue 14"

You can remove issues by using the --rm command, though this should be avoided - unless in error, issues should be preserved for history. You can also change the priority of an issue as needed, using --priority. Finally, you can change the status of an issue using --update:

$ plume --update 14 [new/wip/done]

Again, you can easily add more statuses to the script if you want to. New issues are automatically set to the status new. The user interface is as follows:

Plume UI

Note the first date/time is the time the issue was created, and the second one is the last time it was modified (updated, edited, had its priority changed). The number on the far right is the issue number.

Once you start having a lot of issues, the list might start taking up quite a bit of space. You have the option of using the --short (or -s) flag to hide issues which have been marked done.

plume's People

Contributors

tomcrypto avatar jdowner avatar amireldor avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.