♻️ use only two names, reduce template complexity a bit

Author: enryH

README.md

@@ -5,126 +5,12 @@
 Can be used as GitHub template repository,
 see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
 
-You will need to find and replace occurences of 
+You will need to find and replace occurences of
 
-- `mockup` -> `your_package_name`
-- `rasmussenlab-mockup` -> `your_package_name`
-- `RasmussenLab` -> `GitHub_user_name` (or organization)
 - `python_package` -> `your_package_name`
+- `RasmussenLab` -> `GitHub_user_name` (or `organization`)
 
-with the name of your package and GitHub user name (or organization). This still might
-need further testing:
-
-```bash
-# currently these are (v24.03)
-
-pyproject.toml:
-  5  description = "A small example package"
-  6: name = "rasmussenlab-mockup"
-  7  # This means: Load the version from the package itself.
-
-README.md:
-   7  
-   8: You will need to find and replace occurences of `mockup` with the name of your package. This still might
-   9  need further testing.
-
-  22  
-  23: Install vom [TestPyPI](https://test.pypi.org/project/rasmussenlab-mockup):
-  24  
-  25  ```
-  26: pip install -i https://test.pypi.org/simple/ rasmussenlab-mockup
-  27  ```
-  28  
-  29: > The package on PyPI is call `rasmussenlab-mockup` and not `mockup` as the package name is already taken. The import is still `import mockup`.
-  30  
-
-docs\conf.py:
-   18  
-   19: project = "mockup"
-   20  copyright = "2024, Jakob Nybo Nissen, Henry Webel"
-   21  author = "Jakob Nybo Nissen, Henry Webel"
-   22: PACKAGE_VERSION = metadata.version("rasmussenlab-mockup")
-   23  version = PACKAGE_VERSION
-
-  119      PROJECT_ROOT = Path(__file__).parent.parent
-  120:     PACKAGE_ROOT = PROJECT_ROOT / "src" / "mockup"
-  121  
-
-docs\index.rst:
-   1: .. mockup documentation master file, created by
-   2     sphinx-quickstart on Mon Aug 28 14:09:15 2023.
-
-   5  
-   6: The mockup package
-   7  ==================================
-   8  
-   9: Mockup is a Python package with some simple example code.
-  10: To get started, explore the :class:`mockup.Circle` class.
-  11  
-
-docs\README.md:
-  27  # apidoc
-  28: sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/mockup
-  29  # build docs
-
-docs\tutorial\tutorial.ipynb:
-   6     "source": [
-   7:     "# Mockup tutorial"
-   8     ]
-
-  15     "source": [
-  16:     "from mockup import mockup"
-  17     ]
-
-  24     "source": [
-  25:     "mockup.add_one(-11)"
-  26     ]
-
-  33     "source": [
-  34:     "list(mockup.flatten_ints([[9, 11], [12], [4, 5]]))"
-  35     ]
-
-  42     "source": [
-  43:     "c2 = mockup.Circle.from_circumference(100)\n",
-  44      "round(c2.radius, 3)"
-
-src\mockup\__init__.py:
-  6  
-  7: __version__ = metadata.version("rasmussenlab-mockup")
-  8  
-  9: from .mockup import add_one, Circle
-  10  
-
-tests\test_circle.py:
-  1  import unittest
-  2: from mockup.mockup import Circle
-  3  
-```
-
-And additionally the author names:
-
-```bash
-pyproject.toml:
-  1  [project]
-  2: authors = [
-  3    {name = "Jakob Nybo Nissen", email = "[email protected]"},
-
-README.md:
-  37     20  copyright = "2024, Jakob Nybo Nissen, Henry Webel"
-  38:    21  author = "Jakob Nybo Nissen, Henry Webel"
-  39     22: PACKAGE_VERSION = metadata.version("rasmussenlab-mockup")
-
-  96  
-  97: And additionally the author names:
-  98  
-
-docs\conf.py:
-  20  copyright = "2024, Jakob Nybo Nissen, Henry Webel"
-  21: author = "Jakob Nybo Nissen, Henry Webel"
-  22  PACKAGE_VERSION = metadata.version("rasmussenlab-mockup")
-```
-
-> Potentially a cookiecutter could be based on this template repository.
+with the name of your package and GitHub user name (or organization).
 
 ## Development environment
 
@@ -134,20 +20,19 @@ Install package so that new code is picked up in a restared python interpreter:
 pip install -e ".[dev]"
 ```
 
-## TestPyPI
+## Basic usage
 
-Install vom [TestPyPI](https://test.pypi.org/project/rasmussenlab-mockup):
-
-```
-pip install -i https://test.pypi.org/simple/ rasmussenlab-mockup
+```python
+from python_package import hello_world
+print (python_package.__version__)
+print(hello_world(4))
 ```
 
-> The package on PyPI is call `rasmussenlab-mockup` and not `mockup` as the package name is already taken. The import is still `import mockup`.
-
 ## Readthedocs
 
-The documentation is build using readthedocs automatically. See 
-[project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/).
+The documentation can be build using readthedocs automatically. See
+[project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/) for the project. A new project needs
+to be registered.
 
 - make sure to enable build from PRs in the settings (advanded settings)
 - checkout configuration file: [`.readthedocs.yaml`](.readthedocs.yaml)

docs/README.md

@@ -25,7 +25,7 @@ Options:
 ```bash	
 # pwd: docs
 # apidoc
-sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/mockup
+sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/python_package
 # build docs
 sphinx-build -n -W --keep-going -b html ./ ./_build/
 ```

docs/conf.py

@@ -15,10 +15,10 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "mockup"
-copyright = "2024, Jakob Nybo Nissen, Henry Webel"
+project = "python_package"
+copyright = "2025, Jakob Nybo Nissen, Henry Webel"
 author = "Jakob Nybo Nissen, Henry Webel"
-PACKAGE_VERSION = metadata.version("rasmussenlab-mockup")
+PACKAGE_VERSION = metadata.version("python_package")
 version = PACKAGE_VERSION
 release = PACKAGE_VERSION
 
@@ -128,7 +128,7 @@
     from pathlib import Path
 
     PROJECT_ROOT = Path(__file__).parent.parent
-    PACKAGE_ROOT = PROJECT_ROOT / "src" / "mockup"
+    PACKAGE_ROOT = PROJECT_ROOT / "src" / "python_package"
 
     def run_apidoc(_):
         from sphinx.ext import apidoc

docs/index.md

@@ -0,0 +1,43 @@
+# Python Package Documentation
+
+```{include} ../README.md
+:start-line: 0
+:relative-docs: docs
+:relative-images:
+```
+
+## Tutorial
+
+```{toctree}
+:maxdepth: 2
+:caption: "Tutorials"
+:hidden: true
+
+tutorial/tutorial
+```
+
+## Contents
+
+```{toctree}
+:maxdepth: 2
+:caption: "Reference"
+:hidden: true
+
+reference/python_package
+```
+
+## Technical notes
+
+```{toctree}
+:maxdepth: 2
+:caption: "Technical notes"
+:hidden: true
+
+README
+```
+
+## Indices and tables
+
+- [Index](genindex)
+- [Module Index](modindex)
+- [Search](search)

docs/index.rst

@@ -5,7 +5,10 @@
    "id": "62cb84c2",
    "metadata": {},
    "source": [
-    "# Mockup tutorial"
+    "# Python Package tutorial\n",
+    "\n",
+    "Run when documentation is build. Building documentation therefore can become\n",
+    "an minimal integration test for the package."
    ]
   },
   {
@@ -15,7 +18,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from mockup import mockup"
+    "from python_package import hello_world"
    ]
   },
   {
@@ -25,7 +28,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "mockup.add_one(-11)"
+    "ret = hello_world(2)\n",
+    "ret"
    ]
   },
   {
@@ -35,7 +39,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "list(mockup.flatten_ints([[9, 11], [12], [4, 5]]))"
+    "print(ret)"
    ]
   },
   {
@@ -45,25 +49,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "c2 = mockup.Circle.from_circumference(100)\n",
-    "round(c2.radius, 3)"
+    "hello_world?"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "4ae5341c",
-   "metadata": {},
+   "metadata": {
+    "title": "markdown"
+   },
    "outputs": [],
    "source": [
-    "c2  # repr"
+    "# Simple example for a recipe showing what the package can do."
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1bc4ca39",
-   "metadata": {},
-   "source": []
   }
  ],
  "metadata": {

docs/tutorial/tutorial.ipynb

@@ -1,21 +1,21 @@
 # %% [markdown]
-# # Mockup tutorial
+# # Python Package tutorial
+#
+# Run when documentation is build. Building documentation therefore can become
+# an minimal integration test for the package.
 
 # %%
-from mockup import mockup
+from python_package import hello_world
 
 # %%
-mockup.add_one(-11)
+ret = hello_world(2)
+ret
 
 # %%
-list(mockup.flatten_ints([[9, 11], [12], [4, 5]]))
+print(ret)
 
 # %%
-c2 = mockup.Circle.from_circumference(100)
-round(c2.radius, 3)
+# hello_world?
 
 # %%
-c2  # repr
-
-# %% [markdown]
-#
+# Simple example for a recipe showing what the package can do.