Metadata-Version: 2.4
Name: cupidone
Version: 0.8.0
Summary: CLI to-do list manager
Home-page: https://github.com/vikian050194/cupidone
Author: Kirill Vinogradov
Author-email: vikian050194@gmail.com
License: MIT
Keywords: cli,markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# cupidone

[![MIT license][license-badge]][license-url]
[![Maintenance status][status-badge]][status-url]
[![PyPI version][pypi-badge]][pypi-url]
[![Downloads per week][downloads-badge]][downloads-url]
[![Code coverage][coverage-badge]][coverage-url]

## About

**cupidone** is a tool that can help you track progress on tasks and plan future work

## Motivation

There are a lot of flexible and powerful UI-rich task trackers but as for me all of them are too complex and I don't need a biggest part of provided features

## Requirements

Python version 3.9 or higher

Developed and tested on Ubuntu 20.04

## Usage

In general invocation has following format `cupidone [COMMAND] [SUBCOMMAND] [OPTION] [VALUE]`

### Help

Format: `cupidone [COMMAND]`

| Command | Description |
| --- | --- |
| `help` | Help information |
| `version` | Installed version |

### Initialize

Format: `cupidone init`

To create `TODO.md` and empty `todo` directory

### Add

Format: `cupidone add`

To create new empty card in the `todo` directory

### Build

Format: `cupidone build [OPTION]`

To (re)builds `TODO.md` according to the cards from `todo` directory

| Option | Description |
| --- | --- |
| `todo` | `TODO.md` file |
| `site` | Static site that is kanban-like board stored in `site` directory |

### Dump

Format: `cupidone dump`

To dump all cards from `todo` directory

### Migrate

To migrate from different sources

Format: `cupidone migrate [OPTION] [VALUE]`

| Option | Description |
| --- | --- |
| `trello` | Trello kanban project as source |
| `vanilla` | Vanilla markdown as source |

One value is required - path to exported `JSON` file

**trello**

Your exported data may contains same columns and/or labels or any subset of it.

List of columns:

- "backlog"
- "to do"
- "in progress"
- "done"
- "outdated"

List of labels:

- "bug"
- "tech"
- "business"
- "marketing"

Trello card could contain more than one checklist, but only first checklist will be converted and remaining checklists will be ignored.

**vanilla**

Example of `TODO.md` to explain all cases at once.

```md
# TODO

## Todo

- [x] Make a repository
- [x] Make project template
- [x] Add directory selector
  - [x] Show dialog
  - [x] Show selected directory name
- [ ] ~~Migrate to Web API~~
- [ ] Hide system directories by default
- [ ] Tag photos
  - [x] Add tag
  - [ ] Remove tag
- [ ] Save photo rotation
- [ ] Directories tree

## Backlog

- [ ] Copy file name
  - [ ] Name
  - [ ] Relative path
  - [ ] Absolute path
- [ ] Logical AND
- [ ] ~~Rename file~~
- [ ] Manual date setting
```

### Configuration

There in one way/layer of configuration

**Environment variables**

| Name | Description | Value |
| --- | --- | --- |
| `PWD` | Project directory where `README.md` file and `todo` directory are stored | Any valid path |
| `CUPIDONE_OUTPUT` | Output format | `human`, `plain` or `json` |

[status-url]: https://github.com/vikian050194/cupidone/pulse
[status-badge]: https://img.shields.io/github/last-commit/vikian050194/cupidone.svg

[license-url]: https://github.com/vikian050194/cupidone/blob/master/LICENSE
[license-badge]: https://img.shields.io/github/license/vikian050194/cupidone.svg

[pypi-url]: https://pypi.org/project/cupidone
[pypi-badge]: https://img.shields.io/pypi/v/cupidone

[downloads-url]: https://pypi.org/project/cupidone
[downloads-badge]: https://img.shields.io/pypi/dw/cupidone

[coverage-url]: https://codecov.io/gh/vikian050194/cupidone
[coverage-badge]: https://img.shields.io/codecov/c/github/vikian050194/cupidone
