Release 0.4.0

.copier-answers.yml

@@ -0,0 +1,9 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: 0.1.0
+_src_path: https://github.com/python-accelerator-middle-layer/pyaml-repository-template.git
+distribution_name: tango-pyaml
+html_title: tango-pyaml
+import_name: tango.pyaml
+package_name: tango-pyaml
+repository_url: https://github.com/python-accelerator-middle-layer/tango-pyaml
+use_docs_extra: false

.github/workflows/deploy-pypi.yaml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   deploy:
-  
+
     runs-on: ubuntu-latest
 
     #environment: release
@@ -27,7 +27,7 @@ jobs:
         cache-dependency-path: '**/pyproject.toml'
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip 
+        python -m pip install --upgrade pip
         pip install hatch
     - name: Build package
       run: hatch build

.github/workflows/github-release.yml

@@ -0,0 +1,49 @@
+name: GitHub Release
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Build and create release on GitHub
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install Hatch
+        run: python -m pip install --upgrade hatch
+
+      - name: Build distribution
+        run: hatch build
+
+      - name: Determine whether this is a pre-release
+        id: release_type
+        shell: bash
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+
+          if [[ "$tag" =~ (\.dev[0-9]+|a[0-9]+|b[0-9]+|rc[0-9]+)$ ]]; then
+            echo "prerelease=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v3
+        with:
+          draft: false
+          prerelease: ${{ steps.release_type.outputs.prerelease }}
+          generate_release_notes: true
+          files: dist/*

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
         pip install accelerator-toolbox
         pip install matplotlib
         pip install h5py
-        pip install accelerator-middle-layer
+        pip install "git+https://github.com/python-accelerator-middle-layer/pyaml.git"
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8

.gitignore

@@ -29,6 +29,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+**/_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -55,7 +56,7 @@ coverage.xml
 .pytest_cache/
 cover/
 
-# DS 
+# DS
 **/.DS_Store
 
 # Translations

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements: []

README.md

@@ -1,14 +1,13 @@
 # tango-pyaml
 
-**Bridge between **[**Tango Controls**](https://www.tango-controls.org/)** and PyAML**
-
+**Bridge between **[**Tango Controls**](https://www.tango-controls.org/)** and pyAML**
 
+[![Documentation Status](https://readthedocs.org/projects/tango-pyaml/badge/?version=latest)](https://tango-pyaml.readthedocs.io/en/latest/?badge=latest)
+[![Current release](https://img.shields.io/github/v/release/python-accelerator-middle-layer/tango-pyaml)](https://github.com/python-accelerator-middle-layer/tango-pyaml/releases)
 
 ## Overview
 
-`tango-pyaml` is a Python bridge between the [Tango control system](https://www.tango-controls.org/) and the [PyAML](https://github.com/python-accelerator-middle-layer/pyaml) abstraction layer for control systems. It provides a set of classes that allow Tango attributes and devices to be accessed and controlled using PyAML concepts.
-
-This library is part of the **Python Accelerator Middle Layer (PyAML)** ecosystem.
+`tango-pyaml` is a Python bridge between the [Tango control system](https://www.tango-controls.org/) and the [pyAML](https://github.com/python-accelerator-middle-layer/pyaml) abstraction layer for control systems. It provides a set of classes that allow Tango attributes and devices to be accessed and controlled using pyAML concepts.
 
 ## Features
 
@@ -21,82 +20,38 @@ This library is part of the **Python Accelerator Middle Layer (PyAML)** ecosyste
 
 ## Installation
 
+Install the package from PyPI:
+
 ```bash
 pip install tango-pyaml
 ```
 
-## Requirements
+## Development
 
-- Python >= 3.9
-- [PyTango](https://pytango.readthedocs.io/en/latest/) >= 9.5.1
-- [PyAML](https://github.com/python-accelerator-middle-layer/pyaml)
-- [pydantic](https://docs.pydantic.dev/) >= 2.0
-
-For development and testing:
+Install the development dependencies with:
 
 ```bash
 pip install tango-pyaml[dev]
 ```
 
-## Usage Example
-
-This is an example of an explicit call to a Tango attribute using PyAML. For more details about implicit declaration and broader configuration options, please refer to the [PyAML documentation](https://github.com/python-accelerator-middle-layer/pyaml).
-
-Configuration file `attribute.yaml`:
-
-```yaml
-attribute: "sys/tg_test/1/float_scalar"
-unit: "A"
-```
-
-Python code:
-
-```python
-from tango.pyaml.attribute import Attribute
-from tango.pyaml.tango_attribute import ConfigModel
-import yaml
-
-with open("attribute.yaml") as f:
-    cfg_dict = yaml.safe_load(f)
-
-cfg = ConfigModel(**cfg_dict)
-attr = Attribute(cfg)
-
-attr.set(10.0)
-value = attr.get()
-readback = attr.readback()
-
-print(f"Value: {value}, Readback: {readback.value} [{readback.quality}]")
-```
-
-## Available Classes
-
-- `Attribute` — Read/write access to a Tango attribute
-- `AttributeReadOnly` — Read-only attribute wrapper
-- `AttributeList` — Manage a group of attributes from multiple devices
-- `TangoControlSystem` — Adapter to configure global Tango control system context
-
-## Testing
-
-Tests rely on mocked Tango devices and attributes using `unittest.mock`. To run tests:
+Run the test suite with:
 
 ```bash
 pytest
 ```
 
-## Project Structure
+Install the pre-commit hooks with:
 
-- `tango.pyaml.attribute` – Main attribute interface
-- `tango.pyaml.attribute_read_only` – Read-only attribute implementation
-- `tango.pyaml.attribute_list` – Attribute groups with `tango.Group`
-- `tango.pyaml.tango_attribute` – Base class wrapping attribute logic
-- `mocked_device_proxy.py` – In-memory mock for Tango `DeviceProxy` and `AttributeProxy`
+```bash
+pre-commit install
+```
 
-## License
+## Documentation
 
-This project is licensed under the MIT License.
+The documentation is available at:
 
-## Links
+<https://tango-pyaml.readthedocs.io/en/stable/>
 
-- 🧺 [Repository](https://github.com/python-accelerator-middle-layer/tango-pyaml)
+## Contributing
 
+Please use the issue tracker or submit a pull request.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx~= 8.1
+pydata-sphinx-theme
+myst_parser
+sphinx-copybutton

docs/source/_static/custom.css

@@ -0,0 +1,7 @@
+.api-root h1 {
+    display: none;
+}
+
+.api-generation {
+    display: none;
+}

docs/source/api.rst

@@ -0,0 +1,14 @@
+API Reference
+=============
+
+.. container:: api-generation
+
+   .. autosummary::
+      :toctree: api
+      :recursive:
+
+      tango.pyaml
+
+.. container:: api-root
+
+   .. include:: api/tango.pyaml.rst