refactor(project): organise project to run with pyproject

check-phat-nguoi · Dec 22, 2024 · cfe7d79 · cfe7d79
1 parent 7a4a82d
commit cfe7d79
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,13 @@
 
 ```sh
 python -m venv .venv
-pip install -r requirements.txt
+.\.venv\Scripts\activate # For windows
+pip install --editable .
+gcpn # or "python -m gcpn"
 ```
 
+> [!NOTE] > **main**.py is optional for another way to run project
+
 ### API
 
 <details>

diff --git a/main.py b/main.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,11 @@
+[project]
+name = 'gha-check-phat-nguoi'
+dynamic = ["version"]
+dependencies = ["PyYAML == 6.0.2"]
+
+[project.scripts]
+gcpn = "gcpn:main"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
diff --git a/src/gcpn/__init__.py b/src/gcpn/__init__.py
@@ -0,0 +1,5 @@
+from .modules.config_reader import get_config
+
+
+def main():
+    get_config("config.yml")
diff --git a/src/gcpn/__main__.py b/src/gcpn/__main__.py
@@ -0,0 +1,4 @@
+from . import main
+
+if __name__ == "__main__":
+    main()
diff --git a/src/modules/config_reader.py → src/gcpn/modules/config_reader.py b/src/modules/config_reader.py → src/gcpn/modules/config_reader.py
@@ -1,6 +1,6 @@
 from yaml import safe_load
 
-from src.types.config import Config
+from ..types.config import Config
 
 
 def get_config(file):

diff --git a/src/types/config.py → src/gcpn/types/config.py b/src/types/config.py → src/gcpn/types/config.py