[PACKAGE-1] Package to PIP

.editorconfig

@@ -7,32 +7,19 @@ root = true
 [*]
 end_of_line = lf
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 # Matches multiple files with brace expansion notation
 # Set default charset
-[*.{js,py}]
+[*.{py}]
 charset = utf-8
 
 # 2 space indentation
-[*.json, *.html]
+[*.{yaml,yml,toml}]
 indent_style = space
 indent_size = 2
 
 # 4 space indentation
-[*.py]
+[*.{py,md}]
 indent_style = space
 indent_size = 4
-
-# Tab indentation (no size specified)
-[Makefile]
-indent_style = tab
-
-# Indentation override for all JS under lib directory
-[lib/**.js]
-indent_style = space
-indent_size = 2
-
-# Matches the exact files either package.json or .travis.yml
-[{package.json,.travis.yml}]
-indent_style = space
-indent_size = 2

.env.example

@@ -1,3 +1,3 @@
-GITHUB_PERSONAL_ACCESS_TOKEN=<your_github_personal_access_token>
+GITHUB_TOKEN=<your_github_personal_access_token>
 GITHUB_REPO_OWNER=<target_github_repository_owner>
 GITHUB_REPO_NAME=<target_github_repository_name>

.github/workflows/lint.yaml

@@ -54,5 +54,3 @@ jobs:
           mypy .
           --install-types
           --non-interactive
-          --check-untyped-defs
-          --ignore-missing-imports

.gitignore

@@ -166,4 +166,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

.pre-commit-config.yaml

@@ -6,6 +6,15 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        types_or: [yaml, toml, markdown]
+        additional_dependencies:
+          - prettier@3.0.3
+          - prettier-plugin-toml@1.0.0
+
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.1.1
     hooks:

README.md

@@ -1,72 +1,99 @@
 <div align="center">
-    <img height=100 src="https://github.com/seyLu/setup-issue-label-cli/blob/main/static/icons/labels.png" alt="Setup Github Label CLI Icon">
-    <h1Github Label CLI</h1>
+    <img height=100 src="https://github.com/seyLu/ghlabel/blob/main/labels.png" alt="ghlabel icon">
+    <h1>ghlabel</h1>
     <p>CLI tool to help setup Github Labels from a yaml/json config file.</p>
     <p>
-        <a href="https://github.com/seyLu/setup-issue-label-cli/issues/new">Report Bug</a>
+        <img src="https://github.com/seyLu/ghlabel/actions/workflows/codeql.yaml/badge.svg" alt="Codeql badge">
+        <img src="https://github.com/seyLu/ghlabel/actions/workflows/lint.yaml/badge.svg" alt="Lint badge">
+        <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11+-blue" alt="Python 3.11+ badge"></a>
+        <a href="https://peps.python.org/pep-0008/"><img src="https://img.shields.io/badge/code%20style-pep8-orange.svg" alt="PEP8 badge"></a>
+        <a href="https://github.com/seyLu/ghlabel/blob/main/LICENSE"><img src="https://img.shields.io/github/license/seyLu/ghlabel.svg" alt="MIT License"></a>
+    </p>
+    <p>
+        <a href="https://github.com/seyLu/ghlabel/issues/new">Report Bug</a>
         ·
-        <a href="https://github.com/seyLu/setup-issue-label-cli/issues/new">Request Feature</a>
+        <a href="https://github.com/seyLu/ghlabel/issues/new">Request Feature</a>
         ·
-        <a href="https://github.com/seyLu/setup-issue-label-cli/discussions">Ask Question</a>
+        <a href="https://github.com/seyLu/ghlabel/discussions">Ask Question</a>
     </p>
 </div>
 
 <br>
 
-### Supported Python version
+### Installation and Setup
+
+It is recommended to not install the CLI tool globally.
+
+#### 1. Create a new directory where you want the configuration to live
 
 ```bash
-python==3.11
+mkdir ghlabel
+
+# this is where the labels config will be located
+cd ghlabel
 ```
 
-<br>
+#### 2. Create and activate virtual environment
 
-### Setup
+```bash
+python -m venv .venv
 
-#### 1. Clone the repo
+# Linux/Mac
+. .venv/bin/activate
 
-```bash
-git clone git@github.com:seyLu/setup-github-label-cli.git
+# Windows
+.venv\Scripts\activate.bat
 ```
 
-#### 2. Install dependencies
-
-##### Create a new virtual environment
+#### 3. Install package
 
 ```bash
-python -m venv .venv
+pip install ghlabel
+
+# check if installed
+ghlabel -v
 ```
 
-##### Activate the virtual environment
+#### 4. Create `.env` and supply github credentials
 
 ```bash
 # Linux/Mac
-. .venv/bin/activate
+touch .env
 
 # Windows
-.venv\Scripts\activate.bat
+type nul > .env
+```
+
+```bash
+GITHUB_PERSONAL_ACCESS_TOKEN=<your_github_personal_access_token>
+GITHUB_REPO_OWNER=<target_github_repository_owner>
+GITHUB_REPO_NAME=<target_github_repository_name>
 ```
 
-##### Install dependencies from requirements.txt
+<br>
+
+### Basic Usage
+
+#### 1. Generate labels config
 
 ```bash
-pip install -r requirements.txt
+ghlabel dump
 ```
 
-#### 3. Create `.env` and supply github credentials
+#### 2. Setup labels in GitHub
 
 ```bash
-cp .env.example .env
+ghlabel setup
 ```
 
-##### `.env.example` preview
+<br>
 
+For advanced usage, see:
 ```bash
-GITHUB_PERSONAL_ACCESS_TOKEN=<your_github_personal_access_token>
-GITHUB_REPO_OWNER=<target_github_repository_owner>
-GITHUB_REPO_NAME=<target_github_repository_name>
+ghlabel -h
 ```
 
+<br>
 <br>
 
 ## :red_circle: `ghlabel`
@@ -87,7 +114,7 @@ $ ghlabel [OPTIONS] COMMAND [ARGS]...
 Show version and exit.
 #### `--debug`, `-D`
 Enable debug mode and show logs.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -123,7 +150,7 @@ Specify the dir where to find labels.
 Label file extension.
 #### `--app`, `-a [app|game|web]` [default: app]
 App to determine label template.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -160,7 +187,7 @@ Add more labels.
 Remove more labels.
 #### `--remove-all`, `-R [disable|enable|silent]`  [default: disable]
 Remove all Github labels.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -186,7 +213,7 @@ ghlabel setup -r "Type: Feature Request, Type: Bug"
 ```bash
 # -a [valid json string]
 # will be parsed as list[dict[str, str]]
-ghlabel setup -a "[{'name': 'wontfix', 'color': '##ffffff'}, {'name': 'bug', 'color': '#d73a4a', 'description': 'Something isn't working'}]"
+ghlabel setup -a "[{'name': 'wontfix', 'color': '#ffffff'}, {'name': 'bug', 'color': '#d73a4a', 'description': 'Something isn't working'}]"
 ```
 
 <br>

ghlabel.md

@@ -18,7 +18,7 @@ $ ghlabel [OPTIONS] COMMAND [ARGS]...
 Show version and exit.
 #### `--debug`, `-D`
 Enable debug mode and show logs.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -54,7 +54,7 @@ Specify the dir where to find labels.
 Label file extension.
 #### `--app`, `-a [app|game|web]` [default: app]
 App to determine label template.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -91,7 +91,7 @@ Add more labels.
 Remove more labels.
 #### `--remove-all`, `-R [disable|enable|silent]`  [default: disable]
 Remove all Github labels.
-#### `--help`
+#### `--help`, `-h`
 Show this message and exit.
 
 <br>
@@ -117,5 +117,5 @@ ghlabel setup -r "Type: Feature Request, Type: Bug"
 ```bash
 # -a [valid json string]
 # will be parsed as list[dict[str, str]]
-ghlabel setup -a "[{'name': 'wontfix', 'color': '##ffffff'}, {'name': 'bug', 'color': '#d73a4a', 'description': 'Something isn't working'}]"
+ghlabel setup -a "[{'name': 'wontfix', 'color': '#ffffff'}, {'name': 'bug', 'color': '#d73a4a', 'description': 'Something isn't working'}]"
 ```