Added ngit init, closes #9

Signed-off-by: Nyx <189459385+nyx-4@users.noreply.github.com>

Author: nyx-4

.gitignore

@@ -173,4 +173,4 @@ poetry.toml
 # LSP config files
 pyrightconfig.json
 
-# End of https://www.toptal.com/developers/gitignore/api/python
+# End of https://www.toptal.com/developers/gitignore/api/python

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+repos:
+  - repo: local
+    hooks:
+      - id: pytest-collect
+        name: 🧪 test · Validate test formatting
+        entry: pytest
+        language: system
+        types: [python]
+        args: ["--collect-only"]
+        pass_filenames: false
+        always_run: true
+      # STRICT
+      - id: pytest-fast
+        name: 🧪 test · Run fast tests
+        entry: pytest
+        language: system
+        types: [python]
+        args: []
+        pass_filenames: false
+        always_run: true
+  - repo: local
+    hooks:
+      - id: faq1
+        name: 🧪 FAQ  · Have you updated CHANGELOG?
+        entry: fish -Nc "for i in (seq 10); sleep 1; end;"
+        language: system
+        always_run: true
+      - id: faq2
+        name: 🧪 FAQ  · Have you updated version in pyproject.toml?
+        entry: fish -Nc "for i in (seq 10); sleep 1; end;"
+        language: system
+        always_run: true
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.28.0
+    hooks:
+      - id: gitleaks
+        name: "🔒 security · Detect hardcoded secrets"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+      - id: ruff-format
+        name: "🐍 python · Format with Ruff"
+      # STRICT
+      - id: ruff
+        args: [ '--fix', '--ignore=F401' ]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-executables-have-shebangs
+        name: "📁 filesystem/⚙️ exec · Verify shebang presence"
+      - id: check-shebang-scripts-are-executable
+        name: "📁 filesystem/⚙️ exec · Verify script permissions"
+      - id: check-case-conflict
+        name: "📁 filesystem/📝 names · Check case sensitivity"
+      - id: check-illegal-windows-names
+        name: "📁 filesystem/📝 names · Validate Windows filenames"
+      - id: check-symlinks
+        name: "📁 filesystem/🔗 symlink · Check symlink validity"
+      - id: destroyed-symlinks
+        name: "📁 filesystem/🔗 symlink · Detect broken symlinks"

CHANGELOG.md

@@ -15,7 +15,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
         - Security
  -->
 
-## [Unreleased]
+## [0.1.1]
+
+### Added
+- pre-commit hooks have beed added.
+- A new microproject `ngit` is added.
+- ArgParser is added for better CLI arguments support.
+- Added Sub-ArgParser for `init` sub-command.
+- Added `ngit init` that Initializes a new, empty repository.
+- Added `GitRepository` and some helper functions to assisst `ngit init`.
+- Added ngit/README stub.
+
+### Fixed
+- Minor fixes in calc.
+
+
+## [0.1.0]
 
 ### Changed
 - The min, max and sum functions are changed to accomodate single argument.

README.md

@@ -4,8 +4,34 @@ This is a collection of MicroProjects I code for fun..
 ## Table of Content
 - [MicroProjects](#microprojects)
 - [Table of Content](#table-of-content)
+- [Getting MicroProjects](#getting-microprojects)
+    - [Source](#source)
+    - [PyPI (Python)](#pypi-python)
 - [1. Calculator](#1-calculator)
     - [Usage:](#usage)
+- [2. ngit](#2-ngit)
+    - [Usage:](#usage-1)
+
+## Getting MicroProjects
+
+### Source
+
+Clone the development version from [MicroProjects - GitHub](https://github.com/nyx-4/MicroProjects.git)
+
+```sh
+git clone https://github.com/nyx-4/MicroProjects.git
+cd MicroProjects
+pip install .
+```
+
+### PyPI (Python)
+
+Use the package manager pip to install foobar.
+
+```sh
+pip install microprojects
+```
+
 
 ## 1. [Calculator](https://github.com/nyx-4/MicroProjects/tree/main/microprojects/calc)
 A simple calculator written in Python that _just_ works. The source code is available on [nyx-4/MicroProjects/calc - GitHub](https://github.com/nyx-4/MicroProjects/tree/main/microprojects/calc).
@@ -14,3 +40,14 @@ A simple calculator written in Python that _just_ works. The source code is avai
 - From CLI: `calc 5 + 10 x 3 - 2`
 - As Python module: `python -m microprojects.calc 5 + 10 x 3 - 2`
 - From Python source: `microprojects.calc("5 + 10 x 3 - 2")`
+
+
+## 2. [ngit](https://github.com/nyx-4/MicroProjects/tree/main/microprojects/ngit)
+Git re-implementation in Python that is _perfectly compatible_ with with [Git SCM](https://git-scm.com/). The source code is available on [nyx-4/MicroProjects/ngit - GitHub](https://github.com/nyx-4/MicroProjects/tree/main/microprojects/ngit).
+
+### [Usage](https://github.com/nyx-4/MicroProjects/tree/main/microprojects/ngit#usage):
+- From CLI:
+```sh
+ngit init
+```
+

microprojects/__init__.py

@@ -1,2 +1,3 @@
 from microprojects.calc.calculator import calc_main, calc
 from microprojects.calc import analyzer
+from microprojects.ngit import ngit_main

microprojects/__main__.py

@@ -1,5 +1,12 @@
 def main():
-    print("Did you mean: python -m microprojects.calc")
+    """Running microprojects as a module causes ambuiguity because
+    we provides multiple executable scripts.
+
+    Did you mean:
+        python -m microprojects.calc
+        python -m microprojects.ngit
+    """
+    print(main.__doc__)
 
 
 if __name__ == "__main__":

microprojects/calc/README.md

@@ -195,5 +195,5 @@ Taken verbatium from [math - perform mathematics calculations](https://fishshell
 
 
 ## License
-All the code here is licensed under [GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). The content and tests taken fish-shell are rightfully theirs and covered under [fish license](https://github.com/fish-shell/fish-shell/?tab=License-1-ov-file)
+All my code here is licensed under [GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). The content and tests taken fish-shell are rightfully theirs and covered under [fish license](https://github.com/fish-shell/fish-shell/?tab=License-1-ov-file)
 

microprojects/calc/analyzer.py

@@ -153,10 +153,8 @@ def is_pop_needed(o1, o2) -> bool:
                 output.append(operator_stack.pop())
             operator_stack.pop()
 
-        elif type(token) == str:  # v is operator
-            while len(operator_stack) and is_pop_needed(
-                token, operator_stack[-1]
-            ):
+        elif type(token) is str:  # v is operator
+            while len(operator_stack) and is_pop_needed(token, operator_stack[-1]):
                 output.append(operator_stack.pop())
             operator_stack.append(token)
 
@@ -191,17 +189,15 @@ def solve_rpn(rev_polish: list, precedence: str, known_lexemes: dict):
     idx: int = 0
 
     while idx < len(rev_polish):
-        if type(rev_polish[idx]) == str:
+        if type(rev_polish[idx]) is str:
             op_func = known_lexemes[rev_polish[idx]]
             rev_polish[idx - 2 : idx + 1] = [
                 op_func(rev_polish[idx - 2], rev_polish[idx - 1])
             ]
             idx -= 3  # Because three items are over-written
 
-        elif type(rev_polish[idx]) == list:
-            rev_polish[idx] = solve_func(
-                rev_polish[idx], precedence, known_lexemes
-            )
+        elif type(rev_polish[idx]) is list:
+            rev_polish[idx] = solve_func(rev_polish[idx], precedence, known_lexemes)
         idx += 1
 
     return rev_polish[0]

microprojects/calc/calculator.py

@@ -5,13 +5,13 @@
 
 def calc(expr, *, scale=6, scale_mode="default") -> int | float:
     def Min(*args):
-        return min(args) if type(args) == tuple else args
+        return min(args) if type(args) is tuple else args
 
     def Max(*args):
-        return max(args) if type(args) == tuple else args
+        return max(args) if type(args) is tuple else args
 
     def Sum(*args):
-        return sum(args) if type(args) == tuple else args
+        return sum(args) if type(args) is tuple else args
 
     lexemes: dict = {
         "^": lambda x, y: x**y,
@@ -81,7 +81,6 @@ def Sum(*args):
         "tanh": math.tanh,
         "gamma": math.gamma,
         "lgamma": math.lgamma,
-        "lgamma": math.lgamma,
     }
 
     operators: str = "^%/*+-"