Migrate to src/ layout and replace setup.py with pyproject.toml (#97)

Migrate to src/ layout and replace setup.py with pyproject.toml (#97)

Signed-off-by: Manuel Stausberg <m.stausberg@pm.me>
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>

Author: paketb0te

CONTRIBUTING.md

@@ -51,9 +51,19 @@ $ pip uninstall git-sim
 
 ```console
 $ cd path/to/git-sim
-$ python -m pip install -e .
+$ python -m pip install -e .[dev]
 ```
 
+> Explanation: `python -m pip` uses the `pip` module of the currently active python interpreter.
+>
+> `install -e .[dev]` is the command that `pip` executes, where
+>
+> `-e` means to make it an [editable install](https://setuptools.pypa.io/en/latest/userguide/development_mode.html),
+>
+> the dot `.` refers to the current directory,
+>
+> and `[dev]` tells pip to install the "`dev`" [Extras](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-extras) (which are defined in the `project.optional-dependencies` section of [`pyproject.toml`](./pyproject.toml)).
+
 This will install sources from your cloned repo such that you can edit the source and the changes are reflected instantly.
 
 If you already have the dependencies, you can ignore those using the `--no-deps` flag:

pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "git-sim"
+authors = [{ name = "Jacob Stopak", email = "jacob@initialcommit.io" }]
+description = "Simulate Git commands on your own repos by generating an image (default) or video visualization depicting the command's behavior."
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = [
+    "git",
+    "sim",
+    "simulation",
+    "simulate",
+    "git-simulate",
+    "git-simulation",
+    "git-sim",
+    "manim",
+    "animation",
+    "gitanimation",
+    "image",
+    "video",
+    "dryrun",
+    "dry-run",
+]
+license = { text = "MIT License" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "git-dummy",
+    "gitpython",
+    "manim",
+    "opencv-python-headless",
+    "pydantic_settings",
+    "typer",
+]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = { attr = "git_sim.__version__" }
+
+[project.optional-dependencies]
+dev = ["black", "numpy", "pillow", "pytest"]
+
+[project.scripts]
+git-sim = "git_sim.__main__:app"
+
+[project.urls]
+Homepage = "https://initialcommit.com/tools/git-sim"
+Source = "https://github.com/initialcommit-com/git-sim"