Skip to content

Latest commit

 

History

History
143 lines (93 loc) · 7.93 KB

README.md

File metadata and controls

143 lines (93 loc) · 7.93 KB
Raw

CommentHub

Blazingly fast CLI to manage commented-out code.

   ______                                     __  __  __      __
  / ____/___  ____ ___  ____ ___  ___  ____  / /_/ / / /_  __/ /_
 / /   / __ \/ __ `__ \/ __ `__ \/ _ \/ __ \/ __/ /_/ / / / / __ \
/ /___/ /_/ / / / / / / / / / / /  __/ / / / /_/ __  / /_/ / /_/ /
\____/\____/_/ /_/ /_/_/ /_/ /_/\___/_/ /_/\__/_/ /_/\__,_/_.___/

CommentHub CLI

CommentHub is a "blazingly" 🔥 fast Command Line Interface to manage commented-out blocks in files and provide version control. built with Typer

Installation

To run CommentHub, you need to follow the following steps:

  1. clone the application's source code to a CommentHub/ directory
  2. Create a Python virtual environment and activate it:
$ cd CommentHub/
$ python -m venv ./venv
$ source venv/bin/activate
(venv) $
  1. Install the dependencies:
(venv) $ python -m pip install -r requirements.txt
  1. Initialize the application:
(venv) $ sh build.sh

This command creates a alembic.ini file and adds it to the app/ directory.

.
.
.
.
# output_encoding = utf-8

sqlalchemy.url = sqlite:///db/CommentHubDb.db

[post_write_hooks]
# post_write_hooks defines scripts or Python functions
.
.
.

add the location for the sqllite database file as above (you can change this to any other file location as per requirment)

Next run migrations to create the tables in your database

(venv) $ alembic upgrade heads

Usage

Once you've downloaded the source code and run the installation steps, you can run the following command to access the application's usage description:

$ python app/main.py --help


 Usage: CommentHub [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v        Show the application's version and exit.                                                                       │
│ --install-completion            Install completion for the current shell.                                                                      │
│ --show-completion               Show completion for the current shell, to copy it or customize the installation.                               │
│ --help                          Show this message and exit.                                                                                    │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ remove-comments                            Remove commented out code under comment-tag                                                         │
│ retrieve-comments                          Remove commented out code under comment-tag                                                         │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

You can access the help message for specific commands by typing the command and then --help. For example, to display the help content for the add command, you can run the following:

$ python app/main.py remove-comments --help

 Usage: CommentHub remove-comments [OPTIONS] FILE_LOCATION

 Remove commented out code under comment-tag

╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    file_location      TEXT  [default: None] [required]                                                                                                                        │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                                                     │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Calling --help on each command provides specific and useful information about how to use the command at hand.

Features

CommentHub has the following features:

Command Description
retrieve-comments Retrieves previous versions of commented out blocks
remove-comments Remove commented out code under comment-tag TODO_ID.

Release History

  • 0.0.1
    • A work in progress

Coming up

  • Add persistent database support ⚓
  • Add command to automatically integrate CommentHub with git
  • custom comment-tag support 📝

About the Author

Yuvraj Singh Pathania - Twitter:

Kabir Singh Shekhawat - Twitter