resolves #18 and closes #13

Refactored the ngit source code to better suit ngit needs and
implemented a minimal checkout that kinda works, should redo the
checkout when we'll have staging area and index file

The ngit.drawio, used to understand the relationship among functions can
be found at: https://drive.google.com/file/d/1RpRVO7Vel1Bi0yjyIlCwQDp3Y9UYYhYr/view?usp=sharing

This commit closes #10 also, because that's also kind of completed

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

Author: nyx-4

CHANGELOG.md

@@ -15,7 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
         - Security
  -->
 
-## [Unreleased]
+## [unreleased]
+
+
+## [0.1.2]
 
 ### Added
 - Added Sub-ArgParser for `cat-file` sub-command
@@ -27,70 +30,76 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `CONTRIBUTING` guideline
 - Added a `kvlm_parser` and `kvlm_serializer` to parse and write git commits and tags
 - Added Sub-ArgParser for `log` sub-command
-- Added `ngit log`, git-inspired deviating from official WYAG.
+- Added `ngit log`, more git-inspired, i.e., deviating from official WYAG
 - Added `ngit ls-tree`, list the contents of a tree(-ish) object
+- Added `ngit checkout`, switch branches or restore working tree files
 
 
 ### Changed
 - Changed some ruff defaults in pyproject.toml
 - The GitObject's sub-classes are moved to `object.py`
 
 
+### Fixed
+- The directory structure was fixed to reduce clutter and inter-project dependencies
+- Instead of using general `Exception`, more concrete exceptions are raised
+
 ## [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.
+- 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.
+- Minor fixes in calc
 
 
 ## [0.1.0]
 
 ### Changed
-- The min, max and sum functions are changed to accomodate single argument.
+- The min, max and sum functions are changed to accomodate single argument
 
 ### Fixed
-- Fixed unary - operator.
-- Minor bug-fixes.
+- Fixed unary - operator
+- Minor bug-fixes
 
 ### Removed
-- The test cases that were failing were either edited, or removed completely.
+- The test cases that were failing were either edited, or removed completely
 
 
 
 ## [0.0.3]
 
 ### Added
 
-- Ported tests from [fish-shell](https://github.com/fish-shell/fish-shell/blob/master/tests/checks/math.fish) to pytest.
-- Ported examples from [math - perform mathematics calculations](https://fishshell.com/docs/current/cmds/math.html#examples) to check50 and pytest.
-- Added a simple lexical analyzer (without Error handling).
+- Ported tests from [fish-shell](https://github.com/fish-shell/fish-shell/blob/master/tests/checks/math.fish) to pytest
+- Ported examples from [math - perform mathematics calculations](https://fishshell.com/docs/current/cmds/math.html#examples) to check50 and pytest
+- Added a simple lexical analyzer (without Error handling)
 - Added GitHub workflow for automated testing using pytest
 - Added GitHub workflow for deploymeny to PyPI and TestPyPI
-- Added Shunting yard algorithm to solve Operator precedence.
-- Linked all math.* function in `known_lexemes` by default.
+- Added Shunting yard algorithm to solve Operator precedence
+- Linked all math.* function in `known_lexemes` by default
 - Added reverse polish notation converter & solver
 - Added support for base 2, 8, and 16 using `--base` flag
 
 
 ### Changed
-- The format of `token_stream` returned by `analyzer.lexical_analyzer` is changed.
-- Some tests are changed to simplify logic.
+- The format of `token_stream` returned by `analyzer.lexical_analyzer` is changed
+- Some tests are changed to simplify logic
 
 ## [0.0.1]
-- Setup the skeleton of MicroProjects in an extensible manner.
+- Setup the skeleton of MicroProjects in an extensible manner
 - Added Calculator module
 
 
-<!-- Here comes the `git diff` of each version. -->
-[unreleased]: https://github.com/nyx-4/MicroProjects/compare/v0.1.1...HEAD
+<!-- Here comes the `git diff` of each version -->
+[unreleased]: https://github.com/nyx-4/MicroProjects/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/nyx-4/MicroProjects/compare/v0.1.1...v1.1.2
 [0.1.1]: https://github.com/nyx-4/MicroProjects/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/nyx-4/MicroProjects/compare/v0.0.3...v0.1.0
 [0.0.3]: https://github.com/nyx-4/MicroProjects/compare/v0.0.1...v0.0.3

microprojects/ngit/README.md

@@ -80,6 +80,7 @@ The supported subset of Git's commands are listed here.
 
 
 ### add
+
 ### cat-file
 ```sh
 usage: ngit [-h] [-e | -p | -t | -s] [<type>] object
@@ -99,8 +100,25 @@ options:
 ```
 
 ### check-ignore
+
 ### checkout
+```sh
+usage: ngit [-h] [-q] [-f] [--dest DEST] [branch]
+
+Switch branches or restore working tree files
+
+positional arguments:
+  branch       The branch or commit or tree to checkout
+
+options:
+  -h, --help   show this help message and exit
+  -q, --quiet  Quiet, suppress feedback messages
+  -f, --force  When switching branches, throw away local changes and any untracked files or directories
+  --dest DEST  checkout to <dest> instead of current repository, provided <dest> is empty directory
+```
+
 ### commit
+
 ### hash-object
 ```sh
 usage: ngit [-h] [-t <type>] [-w] [--stdin-paths] [-i] [path ...]
@@ -172,8 +190,31 @@ options:
                         Pretty-print the contents of the commit logs in a given format
   --date FORMAT         The format to use for dates in ngit log
 ```
+
 ### ls-files
 ### ls-tree
+```sh
+usage: ngit [-h] [--format FORMAT_STR] [-d] [-r] [-t] [-l] [-z] [--name-only] [--object-only] [tree]
+
+List the contents of a tree object
+
+positional arguments:
+  tree                  Tree(-ish) object to start at.
+
+options:
+  -h, --help            show this help message and exit
+  --format, --pretty FORMAT_STR
+                        Pretty-print the contents of the tree in a given format
+  -d                    Show only the named tree entry itself, not its children.
+  -r                    Recurse into sub-trees.
+  -t                    Show tree entries even when going to recurse them.
+  -l, --long            Show object size of blob (file) entries.
+  -z                    \0 line termination on output and do not quote filenames.
+  --name-only, --name-status
+                        List only filenames, one per line.
+  --object-only         List only names of the objects, one per line.
+```
+
 ### rev-parse
 ### rm
 ### show-ref