Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.54 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.54 KB

DailyTasks

A tasks manager for those who like work from shell.

PyPI - Version GitHub issue custom search in repo

Installation

Requirements:

  • Python >= 3.11

How install it:

pip install dailytasks

Update process

  1. Before update this package execute dailytasks export command to save all your data.

    1.1. Provide a path to the command (with -p option) is required for it execution, this path is where your data will be saved.

    1.2. This command will create a json file named 'exported_tasks' in the path provided path.

  2. After update execute dailytasks import command to restore all your data.

    2.1. Provide the path provided before (with -p option) and all your data will be restore.

    This is because when you update the CLI, data folder (data_files) is overwritten and all your data deleted.

How to add tasks from a json file

Execute dailytasks import --help to get information about import cmd options.

import options:

  • Normal: dailytasks import -p C:\where\you\export\tasks\are

  • Personalized (A better name is welcome): dailytasks import -a -f your_json_file_name -d key_that_contains_the_descriptions -p C:\where\you\json\file\is

    • -a: Activate this option.
    • -f: To pass name of your json file.
    • -d: The text you want as description should be in a object, in a key-value pair, to this option you will pass key of that key-value pair.
    • -p: To pass path where you json file is.

Testing

Running tests locally:

  1. Clone this repository.

  2. cd into your clone.

  3. Use pytest test to run all tests, use pytest test/test_file_name to run individual tests.

  4. If you get errors around missing daily_task module, reinstall package using pip install dailytasks.

Contributing

Read Contributing file and make whatever question in Discussions.

Thanks to:

Krishnag09 for contributing closing #2 and #8 issues.