Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xypnox/todxpy
A simple and easy to use yet configurable todo app.
https://github.com/xypnox/todxpy
cli easy-to-use pip python python3 todo todoapp website
Last synced: about 1 month ago
JSON representation
A simple and easy to use yet configurable todo app.
- Host: GitHub
- URL: https://github.com/xypnox/todxpy
- Owner: xypnox
- License: gpl-2.0
- Created: 2017-07-02T06:30:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-23T16:05:03.000Z (almost 3 years ago)
- Last Synced: 2024-11-04T04:06:58.608Z (about 2 months ago)
- Topics: cli, easy-to-use, pip, python, python3, todo, todoapp, website
- Language: Python
- Homepage:
- Size: 83 KB
- Stars: 27
- Watchers: 3
- Forks: 23
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todxpy
 [](https://kwoc.kossiitkgp.org/) [](https://saythanks.io/to/xypnox)
**KWoC Communication channel:** [](https://join.slack.com/t/kwoc-koss/shared_invite/enQtODM4MDY3ODIxMzk5LWIzZDUwNmIyNGVkMDEzZjc1Y2YzN2ZhODQxOTFlNzJkYzRlZGU5N2IzYTk3ZWYxN2NiNjk0MGZmYTdmNzhhNjA)
A simple and easy to use yet configurable todo app.
## Installation
To install the program run
```bash
$ pip install todx
```
If you are using Ubuntu run this instead:
```
$ pip3 install todx
```
To check whether the installation was successful run:
```bash
$ 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
```bash
$ echo "export $PATH=~/.local/bin:$PATH" >> ~/.bashrc
```
And then run
```bash
$ source .bashrc
```
- After that check whether the error has been removed or not by running:
```bash
$ 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:
```bash
$ todx add Make me a sandwich
```
You can mark a todo using `todx mark` command:
```bash
$ 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 | ☒ |
| \ | ☐ |
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.
```bash
$ 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.