cprima-pdh 0.0.1__tar.gz

cprima_pdh-0.0.1/.gitignore

@@ -0,0 +1,4 @@
+dist/
+.venv/
+__pycache__/
+.pytest_cache/

cprima_pdh-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Christian Prior-Mamulyan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cprima_pdh-0.0.1/NOTICE

@@ -0,0 +1,17 @@
+cprima-pdh (Practical Digital Housekeeping)
+Copyright 2026 Christian Prior-Mamulyan
+
+This product includes software developed at
+https://github.com/practical-digital-housekeeping/cprima-pdh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

cprima_pdh-0.0.1/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.5
+Name: cprima-pdh
+Version: 0.0.1
+Summary: Practical Digital Housekeeping: keep your digital life in order, starting with your password database.
+Project-URL: Homepage, https://github.com/practical-digital-housekeeping/cprima-pdh/tree/main/packages/cprima-pdh
+Project-URL: Repository, https://github.com/practical-digital-housekeeping/cprima-pdh
+Project-URL: Issues, https://github.com/practical-digital-housekeeping/cprima-pdh/issues
+Author: Christian Prior-Mamulyan
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: digital-housekeeping,kdbx,keepass,password-manager,pdh
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: typer>=0.12
+Provides-Extra: all
+Requires-Dist: pykeepass>=4.1; extra == 'all'
+Provides-Extra: kdbx
+Requires-Dist: pykeepass>=4.1; extra == 'kdbx'
+Description-Content-Type: text/markdown
+
+# cprima-pdh
+
+**Practical Digital Housekeeping.** Keep your digital life in order, starting with your password database.
+Keep it tidy. Keep it trustworthy.
+
+`pdh` is the companion tool of the methodology. This release (0.0.1) is a placeholder: it has the final
+command and install shape but does nothing yet. It never opens, reads or writes a vault.
+
+```powershell
+uvx --from "cprima-pdh[kdbx]" pdh --version
+uvx --from "cprima-pdh[kdbx]" pdh backends
+uvx --from "cprima-pdh[kdbx]" pdh check vault.kdbx
+```
+
+Always use `--from`: plain `uvx pdh` runs an unrelated tool of the same command name.
+
+Licence: Apache-2.0.

cprima_pdh-0.0.1/README.md

@@ -0,0 +1,17 @@
+# cprima-pdh
+
+**Practical Digital Housekeeping.** Keep your digital life in order, starting with your password database.
+Keep it tidy. Keep it trustworthy.
+
+`pdh` is the companion tool of the methodology. This release (0.0.1) is a placeholder: it has the final
+command and install shape but does nothing yet. It never opens, reads or writes a vault.
+
+```powershell
+uvx --from "cprima-pdh[kdbx]" pdh --version
+uvx --from "cprima-pdh[kdbx]" pdh backends
+uvx --from "cprima-pdh[kdbx]" pdh check vault.kdbx
+```
+
+Always use `--from`: plain `uvx pdh` runs an unrelated tool of the same command name.
+
+Licence: Apache-2.0.

cprima_pdh-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "cprima-pdh"
+version = "0.0.1"
+description = "Practical Digital Housekeeping: keep your digital life in order, starting with your password database."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Christian Prior-Mamulyan" }]
+keywords = ["keepass", "kdbx", "password-manager", "digital-housekeeping", "pdh"]
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Security",
+    "Topic :: Utilities",
+]
+dependencies = ["typer>=0.12"]
+
+[project.optional-dependencies]
+kdbx = ["pykeepass>=4.1"]
+all = ["cprima-pdh[kdbx]"]
+
+[project.scripts]
+pdh = "cprima_pdh.cli:app"
+
+[project.entry-points."pdh.backends"]
+kdbx = "cprima_pdh.backends.kdbx:Backend"
+
+[project.urls]
+Homepage = "https://github.com/practical-digital-housekeeping/cprima-pdh/tree/main/packages/cprima-pdh"
+Repository = "https://github.com/practical-digital-housekeeping/cprima-pdh"
+Issues = "https://github.com/practical-digital-housekeeping/cprima-pdh/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cprima_pdh"]

cprima_pdh-0.0.1/src/cprima_pdh/__init__.py

@@ -0,0 +1,7 @@
+"""Practical Digital Housekeeping (PDH): the companion tool of the methodology."""
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("cprima-pdh")
+except PackageNotFoundError:  # running from a source tree without installation
+    __version__ = "0.0.0"

cprima_pdh-0.0.1/src/cprima_pdh/backends/__init__.py

@@ -0,0 +1,56 @@
+"""Backends are plugins in the entry-point group `pdh.backends`; the entry-point name is the extra name."""
+from __future__ import annotations
+
+from dataclasses import dataclass
+from importlib.metadata import entry_points
+from pathlib import Path
+
+GROUP = "pdh.backends"
+
+
+class BackendMissing(Exception):
+    pass
+
+
+@dataclass(frozen=True)
+class BackendInfo:
+    name: str
+    available: bool  # its dependencies are installed
+    detail: str
+
+
+def _eps():
+    return {ep.name: ep for ep in entry_points(group=GROUP)}
+
+
+def install_hint(name: str) -> str:
+    return f'uvx --from "cprima-pdh[{name}]" pdh ...'
+
+
+def load(name: str):
+    """The backend class for `name`; its dependencies are imported only now."""
+    eps = _eps()
+    if name not in eps:
+        raise BackendMissing(f'no backend "{name}"; install it with: {install_hint(name)}')
+    backend = eps[name].load()
+    missing = backend.missing_dependencies()
+    if missing:
+        raise BackendMissing(f'backend "{name}" needs {", ".join(missing)}; install it with: {install_hint(name)}')
+    return backend
+
+
+def for_path(path: Path) -> str:
+    """The backend name for a source path, from its suffix (`vault.kdbx` -> `kdbx`)."""
+    suffix = path.suffix.lstrip(".").lower()
+    if not suffix:
+        raise BackendMissing(f"cannot tell the backend of {path.name!r}; use --source <backend>:<location>")
+    return suffix
+
+
+def available() -> list[BackendInfo]:
+    out = []
+    for name, ep in sorted(_eps().items()):
+        backend = ep.load()
+        missing = backend.missing_dependencies()
+        out.append(BackendInfo(name, not missing, "ready" if not missing else f"missing: {', '.join(missing)}"))
+    return out

cprima_pdh-0.0.1/src/cprima_pdh/backends/kdbx.py

@@ -0,0 +1,13 @@
+"""KDBX (KeePass) backend. Placeholder: it reports whether its dependencies are installed, nothing else."""
+from __future__ import annotations
+
+from importlib.util import find_spec
+
+
+class Backend:
+    name = "kdbx"
+    requires = ("pykeepass",)
+
+    @classmethod
+    def missing_dependencies(cls) -> list[str]:
+        return [m for m in cls.requires if find_spec(m) is None]

cprima_pdh-0.0.1/src/cprima_pdh/cli.py

@@ -0,0 +1,47 @@
+"""The `pdh` command. 0.0.x is a placeholder: final shape, no operation on any vault."""
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Annotated, Optional
+
+import typer
+
+from . import __version__, backends
+
+app = typer.Typer(no_args_is_help=True, help="Practical Digital Housekeeping. Keep it tidy. Keep it trustworthy.")
+
+
+def _version(value: bool) -> None:
+    if value:
+        typer.echo(f"pdh {__version__} (cprima-pdh, Practical Digital Housekeeping)")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: Annotated[
+        Optional[bool], typer.Option("--version", callback=_version, is_eager=True, help="Show the version.")
+    ] = None,
+) -> None:
+    """Practical Digital Housekeeping: keep your digital life in order, starting with your password database."""
+
+
+@app.command("backends")
+def list_backends() -> None:
+    """List the installed backends and whether their dependencies are present."""
+    for b in backends.available():
+        typer.echo(f"{b.name:10} {b.detail}")
+
+
+@app.command()
+def check(
+    path: Annotated[Path, typer.Argument(help="The store to check, e.g. vault.kdbx.")],
+) -> None:
+    """Check a store against the method. Not implemented yet: the store is never opened."""
+    try:
+        name = backends.for_path(path)
+        backends.load(name)
+    except backends.BackendMissing as exc:
+        typer.echo(f"pdh: {exc}", err=True)
+        raise typer.Exit(2)
+    typer.echo(f"pdh {__version__}: backend {name} is ready; check is not implemented yet. {path.name} was not opened.")

cprima_pdh-0.0.1/tests/test_skeleton.py

@@ -0,0 +1,41 @@
+"""The placeholder release: final command shape, no vault access."""
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from cprima_pdh import backends
+from cprima_pdh.cli import app
+
+run = CliRunner().invoke
+
+
+def test_version_names_the_method():
+    out = run(app, ["--version"]).stdout
+    assert out.startswith("pdh ") and "Practical Digital Housekeeping" in out
+
+
+def test_kdbx_backend_is_registered_as_an_entry_point():
+    assert "kdbx" in {b.name for b in backends.available()}
+
+
+def test_backend_is_chosen_by_suffix():
+    assert backends.for_path(Path("Vault.KDBX")) == "kdbx"
+
+
+def test_check_never_opens_the_file(tmp_path):
+    missing = tmp_path / "does-not-exist.kdbx"  # would fail loudly if anything tried to open it
+    result = run(app, ["check", str(missing)])
+    assert result.exit_code == 0 and "not implemented yet" in result.stdout and "was not opened" in result.stdout
+
+
+def test_unknown_backend_names_the_install_line(tmp_path):
+    result = run(app, ["check", str(tmp_path / "x.bitwarden")])
+    assert result.exit_code == 2 and 'cprima-pdh[bitwarden]' in result.stderr
+
+
+def test_missing_dependency_names_the_install_line(monkeypatch, tmp_path):
+    from cprima_pdh.backends import kdbx
+
+    monkeypatch.setattr(kdbx.Backend, "requires", ("surely_not_installed_module",))
+    result = run(app, ["check", str(tmp_path / "v.kdbx")])
+    assert result.exit_code == 2 and 'cprima-pdh[kdbx]' in result.stderr