Release v0.1.0

Author: AAriam

.github/workflows/_pkg_publish.yaml

@@ -0,0 +1,63 @@
+
+name: 'Package - Build'
+run-name: 'Package: Build from ${{github.ref}}'
+
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'pkg/pyproject.toml'
+
+jobs:
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: PyPI
+    steps:
+      - name: 'Checkout repository from ${{github.ref}}'
+        uses: actions/checkout@v4
+
+      - name: 'Build sdist'
+        run: |
+          cd pkg
+          pipx run build --sdist --wheel --outdir dist/
+
+      - name: 'Upload package'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # https://github.com/marketplace/actions/pypi-publish
+        with:
+          packages-dir: pkg/dist
+          verify-metadata: false
+          verbose: true
+          print-hash: true
+          skip-existing: false
+
+  publish-testpypi:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: TestPyPI
+    steps:
+      - name: 'Checkout repository from ${{github.ref}}'
+        uses: actions/checkout@v4
+
+      - name: 'Build sdist'
+        run: |
+          cd pkg
+          pipx run build --sdist --wheel --outdir dist/
+
+      - name: 'Upload package'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # https://github.com/marketplace/actions/pypi-publish
+        with:
+          packages-dir: pkg/dist
+          repository-url: https://test.pypi.org/legacy/
+          verify-metadata: false
+          verbose: true
+          print-hash: true
+          skip-existing: false

.gitignore

@@ -0,0 +1,149 @@
+# Ref: https://github.com/github/gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/website/_build/
+docs/website/source/api/_autosummary
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+# There are reports this comes from LLVM profiling, but also Xcode 9.
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# profraw files from LLVM? Unclear exactly what triggers this
+# There are reports this comes from LLVM profiling, but also Xcode 9.
+*profraw
+
+# In-tree generated files
+*/_version.py
+
+# VSCode
+.vscode/
+
+# PyCharm
+.idea/
+
+# MacOS system files
+.DS_Store
+
+# PyPackIT
+data/_local_reports/
+data/_cache/
+!/dev/build/

pkg/MANIFEST.in

@@ -0,0 +1 @@
+graft src/pycacheman

pkg/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=61.0", "versioningit"]
+build-backend = "setuptools.build_meta"
+
+
+# ----------------------------------------- setuptools -------------------------------------------
+[tool.setuptools]
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = true
+
+
+# ----------------------------------------- Project Metadata -------------------------------------
+[project]
+version = "0.1.0"
+name = "PyCacheMan"
+requires-python = ">=3.10"
+dependencies = [
+    "loggerman >=0.1,<0.2",
+    "mdit >=0.1,<0.2",
+    "pkgdata >=0.1,<0.2",
+    "pyserials >=0.1,<0.2",
+]

pkg/src/pycacheman/__init__.py

@@ -0,0 +1,2 @@
+"""PyCacheMan"""
+

pkg/src/pycacheman/data/schema/serializable_cache.yaml

@@ -0,0 +1,22 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+title: Serializable Cache
+description: |
+  Cached data that can be serialized to a file.
+type: object
+additionalProperties:
+  title: Cache Category
+  description: A group of cached data with a common retention time.
+  type: object
+  additionalProperties:
+    title: Cached Datapoint
+    description: |
+      A specific cached data within the group.
+    type: object
+    required: [ timestamp, data ]
+    additionalProperties: false
+    properties:
+      timestamp:
+        description: Timestamp of the last update.
+        type: string
+      data:
+        description: Cached data.

pkg/src/pycacheman/exception.py

@@ -0,0 +1,9 @@
+"""Exceptions raised by PyCacheMan."""
+
+
+class PyCacheManError(Exception):
+    """Base class for all exceptions raised by PyCacheMan."""
+    def __init__(self, message: str):
+        super().__init__(message)
+        self.message = message
+        return