fix docs after project name change (+"_AS")

Author: andreascaglioni

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Run tests (with coverage)
         run: |
-          python -m pytest -q --cov=python_project_template --cov-report=term --cov-report=html
+          python -m pytest -q --cov=python_project_template_AS --cov-report=term --cov-report=html
 
       - name: Upload HTML coverage
         if: always()

README.md

@@ -1,7 +1,7 @@
 [![CI](https://github.com/andreascaglioni/python-project-template/actions/workflows/tests.yml/badge.svg)](https://github.com/andreascaglioni/python-project-template/actions/workflows/tests.yml)
 [![Docs](https://github.com/andreascaglioni/python-project-template/actions/workflows/docs.yml/badge.svg)](https://github.com/andreascaglioni/python-project-template/actions/workflows/docs.yml)
-[![codecov](https://codecov.io/gh/andreascaglioni/python-project-template/branch/main/graph/badge.svg)](https://codecov.io/gh/andreascaglioni/python-project-template)
-[![PyPI Version](https://img.shields.io/pypi/v/python-project-template.svg)](https://pypi.org/project/python-project-template/)
+[![PyPI Version](https://img.shields.io/pypi/v/python-project-template.svg)](https://pypi.org/project/python-project-template-AS/)
+[![TestPyPI Version](https://img.shields.io/badge/TestPyPI-latest-informational.svg)](https://test.pypi.org/project/python-project-template-AS/)
 [![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
@@ -43,14 +43,20 @@ This simple code is used to showcase some good coding practices.
 
 ## Installation
 
-Clone the repository, create a virtual environment (recommended), and install dependencies and an editable installation of `python-project-template`:
+To install the latest release from TestPyPI, use:
 
 ```bash
-git clone <https://github.com/andreascaglioni/python-project-template>
-cd python-project-template
 python3 -m venv .venv
 source .venv/bin/activate
-python -m pip install --upgrade pip setuptools wheel
+python -m pip install --upgrade pip
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple python-project-template-AS
+```
+
+Alternatively, you can clone the repository, create a virtual environment (recommended), and install dependencies and an editable installation of `python-project-template`:
+
+```bash
+git clone <https://github.com/andreascaglioni/python-project-template>
+cd python-project-template
 pip install -e ".[dev]"
 ```
 
@@ -59,7 +65,7 @@ pip install -e ".[dev]"
 The following is a quick example for the Calculator API.
 
 ```python
-from python_project_template import default_calculator, Operation
+from python_project_template_AS import default_calculator, Operation
 
 # Create a default calculator (pre-populated with common operations)
 calc = default_calculator()
@@ -88,20 +94,26 @@ print(calc.apply('inc', 4))  # -> 5
 
 For detailed documentation, please visit our [GitHub Pages](https://andreascaglioni.github.io/your-repo-name/).
 
+To build the documentation locally:
+
+1. Ensure all dependencies for documentation (e.g., Sphinx) generation are installed, for example running ``pip install -e ".[docs]"``.
+2. Run the documentation build command (for example, ``make html``).
+3. Review the generated HTML in ``docs/_build/html``.
+
 ## Running tests
 
 Run the full PyTest test suite with coverage:
 
 ```bash
-pytest -q --cov=python_project_template --cov-report=term --cov-report=html
+pytest -q --cov=python_project_template_AS --cov-report=term --cov-report=html
 ```
 
 Open `htmlcov/index.html` to view the coverage report.
 
 ## Project structure
 
 ```
-src/python_project_template/      # Core library package
+src/python_project_template_AS/   # Core library package
   calculator.py                   # Calculator API
   operations.py                   # Built-in operations
   registry.py                     # Operation registry

docs/api.rst

@@ -6,33 +6,33 @@ This section documents the public API exposed by the `python-project-template` p
 .. autosummary::
    :toctree: _autosummary
 
-   python_project_template.calculator
-   python_project_template.operations
-   python_project_template.registry
-   python_project_template.exceptions
-   python_project_template.utils
+   python_project_template_AS.calculator
+   python_project_template_AS.operations
+   python_project_template_AS.registry
+   python_project_template_AS.exceptions
+   python_project_template_AS.utils
 
 
 
-.. automodule:: python_project_template.calculator
+.. automodule:: python_project_template_AS.calculator
     :members:
     :undoc-members:
     :noindex:
     :show-inheritance:
 
-.. automodule:: python_project_template.operations
+.. automodule:: python_project_template_AS.operations
     :members:
     :noindex:
     :undoc-members:
 
-.. automodule:: python_project_template.registry
+.. automodule:: python_project_template_AS.registry
     :members:
     :noindex:
 
-.. automodule:: python_project_template.exceptions
+.. automodule:: python_project_template_AS.exceptions
     :members:
     :noindex:
 
-.. automodule:: python_project_template.utils
+.. automodule:: python_project_template_AS.utils
     :members:
     :noindex:

docs/conf.py

@@ -6,7 +6,7 @@
 sys.path.insert(0, os.path.abspath("../src"))
 
 # -- Project information -----------------------------------------------------
-project = "python-project-template"
+project = "python-project-template-AS"
 author = "Andrea Scaglioni"
 # Keep in sync with pyproject.toml
 release = "0.1.0"

docs/structure.rst

@@ -4,7 +4,7 @@ Project Structure
 The project has the following directory structure:
 ::
 
-   src/python_project_template/      # Core library package
+   src/python_project_template_AS/   # Core library package
      calculator.py                   # Calculator API
      operations.py                   # Built-in operations
      registry.py                     # Operation registry

docs/tests.rst

@@ -17,6 +17,6 @@ Run the full PyTest test suite with coverage:
 
 .. code-block:: bash
 
-   pytest -q --cov=python_project_template --cov-report=term --cov-report=html
+   pytest -q --cov=python_project_template_AS --cov-report=term --cov-report=html
 
 Open ``htmlcov/index.html`` to view the coverage report.

docs/usage.rst

@@ -9,7 +9,7 @@ The following is a quick example for the Calculator API. It shows how to:
 
 .. code-block:: python
 
-    from python_project_template import default_calculator, Operation
+    from python_project_template_AS import default_calculator, Operation
 
     calc = default_calculator()
 

src/python_project_template_AS/__init__.py

@@ -1,4 +1,4 @@
-"""Top-level package for python_project_template.
+"""Top-level package for python_project_template_AS.
 
 This package exposes the core types and a small set of convenience symbols
 for the mini calculator demo project.

src/python_project_template_AS/calculator.py

@@ -33,21 +33,10 @@ def __init__(self, registry: Optional[OperationRegistry] = None):
             self.registry = registry
 
     def register(self, op: Operation, *, replace: bool = False) -> None:
-        """Register an :class:`Operation` with the calculator's registry.
-
-        Args:
-            op: Operation to register.
-            replace: If True, replace an existing operation with the same name.
-        """
 
         self.registry.register(op, replace=replace)
 
     def apply(self, op_name: str, *args: Any) -> Any:
-        """Apply a named operation to the provided arguments.
-
-        Raises:
-            OperationError: wraps underlying errors from the operation call.
-        """
 
         op = self.registry.get(op_name)
         try:
@@ -60,12 +49,6 @@ def apply(self, op_name: str, *args: Any) -> Any:
     def compose(
         self, ops: Iterable[str], *, left_to_right: bool = True
     ) -> Callable[[Any], Any]:
-        """Compose a sequence of unary operations into a callable.
-
-        Only supports unary operations (arity == 1). The returned function
-        accepts a single value and applies the operations in the requested
-        order.
-        """
 
         op_list: List[Operation] = [self.registry.get(name) for name in ops]
         for op in op_list:
@@ -91,12 +74,6 @@ def composed(x):
         return composed
 
     def chain(self, sequence: Iterable[Union[str, int]], initial: Any) -> Any:
-        """Apply a mixed sequence of operations to an initial value.
-
-        The sequence may contain operation names (str) and literal integer values.
-        Binary operations consume the current value and the next literal.
-        This helper is intentionally small and tailored for tests/examples.
-        """
 
         seq = list(sequence)
         cur = initial