Merge pull request #29 from bybatkhuu/dev

🧑‍💻 Refactor installation instructions: update pip install…

Author: bybatkhuu

.github/workflows/1.bump-version.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install -U pip
-          python -m pip install -r ./requirements/requirements.test.txt
+          python -m pip install .[test]
       - name: Test with pytest
         run: ./scripts/test.sh -l
 

README.md

@@ -117,7 +117,7 @@ pip install -e .
 **OPTION C.** Install for **DEVELOPMENT** environment:
 
 ```sh
-pip install -r ./requirements/requirements.dev.txt
+pip install -e .[dev]
 ```
 
 **OPTION D.** Install from **pre-built package** files (for **PRODUCTION**):
@@ -262,7 +262,7 @@ To run tests, run the following command:
 
 ```sh
 # Install python test dependencies:
-pip install -r ./requirements/requirements.test.txt
+pip install .[test]
 
 # Run tests:
 python -m pytest -sv -o log_cli=true

docs/dev/test.md

@@ -8,7 +8,7 @@ To run tests, run the following command:
 
 ```sh
 # Install python test dependencies:
-pip install -r ./requirements/requirements.test.txt
+pip install .[test]
 
 # Run tests:
 python -m pytest -sv -o log_cli=true

docs/getting-started/installation.md

@@ -62,7 +62,7 @@ pip install -e .
 **OPTION C.** Install for **DEVELOPMENT** environment:
 
 ```sh
-pip install -r ./requirements/requirements.dev.txt
+pip install -e .[dev]
 ```
 
 **OPTION D.** Install from **pre-built package** files (for **PRODUCTION**):

pyproject.toml

@@ -39,10 +39,18 @@ dynamic = ["version", "dependencies", "optional-dependencies"]
 [tool.setuptools.dynamic]
 version = { attr = "simple_model.__version__.__version__" }
 dependencies = { file = "./requirements.txt" }
-optional-dependencies.extra = { file = [
-	"./requirements/requirements.extra.txt",
-] }
 # optional-dependencies.gpu = { file = ["./requirements/requirements.gpu.txt"] }
+optional-dependencies.test = { file = ["./requirements/requirements.test.txt"] }
+optional-dependencies.build = { file = [
+	"./requirements/requirements.build.txt",
+] }
+optional-dependencies.docs = { file = ["./requirements/requirements.docs.txt"] }
+optional-dependencies.dev = { file = [
+	"./requirements/requirements.test.txt",
+	"./requirements/requirements.build.txt",
+	"./requirements/requirements.docs.txt",
+	"./requirements/requirements.dev.txt",
+] }
 
 # [tool.pyright]
 # venvPath = "."

requirements.txt

@@ -1,3 +1,3 @@
 python-dotenv>=1.0.1,<2.0.0
-pydantic>=2.0.3,<3.0.0
+pydantic[email,timezone]>=2.0.3,<3.0.0
 scikit-learn>=1.4.2,<2.0.0

requirements/requirements.dev.txt

@@ -1,8 +1,8 @@
--e .
--r ./requirements.test.txt
--r ./requirements.build.txt
--r ./requirements.docs.txt
--r ./requirements.extra.txt
+# -e .
+# -r ./requirements.test.txt
+# -r ./requirements.build.txt
+# -r ./requirements.docs.txt
+# -r ./requirements.extra.txt
 pyright>=1.1.392,<2.0.0
 pre-commit>=4.0.1,<5.0.0
 jupyterlab>=4.0.13,<5.0.0

requirements/requirements.extra.txt

@@ -1,4 +1,4 @@
--r ../requirements.txt
+# -r ../requirements.txt
 pytest>=8.0.2,<9.0.0
 pytest-cov>=5.0.0,<8.0.0
 pytest-xdist>=3.6.1,<4.0.0