add new req txt format to template, update readme

Author: antheas

README.md

@@ -63,8 +63,8 @@ source venv/bin/activate
 # Freeze your dependencies to allow reproducible installs between colleagues
 # and install the default project dependencies.
 pip install pip-tools
-pip-compile src/requirements.txt -o src/requirements.lock
-pip install -r src/requirements.lock
+pip-compile --resolver=backtracking
+pip install -r requirements.txt
 ```
 You can now download and synthesize datasets!
 ```bash

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pasteur"
-version = "0.3.0"
+version = "0.3.1"
 authors = [
   { name="Kapenekakis Antheas", email="[email protected]" },
 ]
@@ -49,10 +49,10 @@ cls = [
 docs = [
   "docutils",
   "sphinx~=6.0",
-  "sphinx-book-theme",
+  "sphinx-book-theme~=1.0.1",
   "nbsphinx",
   "recommonmark",
-  "sphinx-autodoc-typehints",
+  "sphinx-autodoc-typehints~=1.23.2",
   "sphinx_copybutton",
   "Jinja2",
   "sphinx-autobuild",

src/pasteur/templates/project/hooks/post_gen_project.py

@@ -1,10 +1,10 @@
 import pasteur
 
 # Inject pasteur version
-with open('src/requirements.txt', "r") as f:
+with open("requirements.in", "r") as f:
     reqs = f.read()
 
-reqs = reqs.replace("pasteur[opt,test,docs]", f"pasteur[opt,test,docs]~={pasteur.version}")
+reqs = reqs.replace("pasteur[opt,test]", f"pasteur[opt,test]~={pasteur.version}")
 
-with open('src/requirements.txt', "w") as f:
-    f.write(reqs)
+with open("requirements.in", "w") as f:
+    f.write(reqs)

src/pasteur/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml

@@ -1,3 +1,14 @@
+[project]
+name = "{{ cookiecutter.python_package }}"
+version = "0.1"
+
+[project.entry-points."console_scripts"]
+{{ cookiecutter.repo_name }} = "{{ cookiecutter.python_package }}.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]  # list of folders that contain the packages (["."] by default)
+exclude = ["test"]
+
 [tool.kedro]
 package_name = "{{ cookiecutter.python_package }}"
 project_name = "{{ cookiecutter.project_name }}"
@@ -14,4 +25,4 @@ addopts = """
 [tool.coverage.report]
 fail_under = 0
 show_missing = true
-exclude_lines = ["pragma: no cover", "raise NotImplementedError"]
+exclude_lines = ["pragma: no cover", "raise NotImplementedError"]

src/pasteur/templates/project/{{ cookiecutter.repo_name }}/src/requirements.txt renamed to src/pasteur/templates/project/{{ cookiecutter.repo_name }}/requirements.in

@@ -1,5 +1,6 @@
 # You can find Pasteur's recommended extensions in
 # https://github.com/pasteur-dev/pasteur/blob/master/pyproject.toml
 # as a reference for your own config file.
+-e file:.
 kedro~={{ cookiecutter.kedro_version }}
-pasteur[opt,test,docs]
+pasteur[opt,test]