https://github.com/dtgoitia/wip-manager

https://github.com/dtgoitia/wip-manager

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dtgoitia/wip-manager
• Owner: dtgoitia
• Created: 2021-09-01T07:55:39.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-24T07:46:39.000Z (over 2 years ago)
• Last Synced: 2024-10-28T13:54:52.001Z (2 months ago)
• Language: Python
• Size: 49.8 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Set up

Developed and tested with Python 3.10.6.

* Install:

  ```shell

  git clone [email protected]:dtgoitia/wip-manager.git

  cd wip-manager

  # Create and activate Python virtual environment

  python3 -m venv .venv

  . .venv/bin/activate

  make install_development_dependencies

  # (optional) install repo under ~/.local/bin

  scripts/install.sh

  # NOTE: ensure ~/.local/bin is in your PATH

  ```

* Configuration (mandatory):

  At `~/.config/wip-manager/config.json`:

  ```json

  {

    "wip_path": "~/path/to/my/wip/file.md",

    "archive_path": "~/path/to/my/archive/file.md"

  }

  ```

* Uninstall:

  ```shell

  scripts/uninstall.sh

  ```

## Usage:

* Validate WIP file:

  ```shell

  python -m src.cli.cli validate

  ```

  It fails if the parsed WIP file cannot be restored as it was after being parsed.

  If it fails, you can use the `--debug` option to get a dump to compare against the original file.

* Clean-up completed tasks:

  ```shell

  python -m src.cli.cli clean

  ```

  Move completed tasks from the WIP file (at `wip_path`) into the archive file (`archive_path`).