Git Product home page Git Product logo

todxpy's Introduction

todxpy

Travis (.org) KWoC 2018 Say Thanks

KWoC Communication channel: Gitter

A simple and easy to use yet configurable todo app.

todx screenshot

Installation

To install the program run

$ pip install todx

If you are using Ubuntu run this instead:

$ pip3 install todx

To check whether the installation was successful run:

$ todx -v

This should output something like TodX vX.X.X depending on your version number

Troubleshoot Error

One of the reason of the error might be that your .local/bin directory is not in path

You may troubleshoot this error by running the following commands:

  • Open the terminal and type the following command to add a line at the end of .bashrc that it may troubleshoot the error
$ echo "export $PATH=~/.local/bin:$PATH" >> ~/.bashrc

And then run

$ source .bashrc
  • After that check whether the error has been removed or not by running:
$ todx -v
  • If the error had been removed successfully it would show you the version of todx.

Usage

You can add todos using the todx add command:

$ todx add Make me a sandwich

You can mark a todo using todx mark command:

$ todx mark
0 ☐  Make a great website 

Which todo you want to mark: 0
What is your new status: v

To see todos you just need to run the todx command:

$ todx
☐  Make me a sandwich

To view todos that you that you have already marked also, run todx view.

There are only few characters that are recognized as a completed todo, they given below:

Character Representation
v
x
<space>

You can remove a todo using todx del command (It works similar to todx mark).

You can use tags for todos, Just add a + before your work to add it to a todo.

$ todx add Make a python script to fetch data +project

To view todos of current tags use todx +tagname

A detailed blogpost covering the use is at : https://xypnox.github.io/blag/posts/todx-the-todo-manager/

Contribution

Contributions are welcomed, any bug fixes or new feature is great.

Contribution Guidelines
  • Raise an issue regarding it.
  • Fix it and make a pull request if it woule be worth your pull request will get merged.
  • You may join the gitter channel for disscuing the issue and for more information.

todxpy's People

Watchers

James Cloos 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.