bdbox 0.1.0__tar.gz

bdbox-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# Python
+__pycache__/
+*.egg-info/
+*.py[cod]
+
+# uv and packaging
+.venv/
+/build/
+/dist/
+
+# Development tools
+.cache/
+.coverage*
+.pytest_cache/
+.ruff_cache/
+/htmlcov/
+/site/
+coverage.xml

bdbox-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing to bdbox
+
+**Contributions are welcome!**
+
+Thank you for your time and interest in improving
+**bdbox**!
+
+## Project resources
+
+* **Web site**: **<https://smkent.github.io/bdbox>**
+  for general project information, usage, and development documentation
+* **Repository**: <https://github.com/smkent/bdbox>
+  for submitting pull requests
+* **Issue tracker**: <https://github.com/smkent/bdbox/issues>
+  for questions or bug reports

bdbox-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+    Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+"The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+a) under this License, provided that you make a good faith effort to
+ensure that, in the event an Application does not supply the
+function or data, the facility still operates, and performs
+whatever part of its purpose remains meaningful, or
+
+b) under the GNU GPL, with none of the additional permissions of
+this License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the
+Library is used in it and that the Library and its use are
+covered by this License.
+
+b) Accompany the object code with a copy of the GNU GPL and this license
+document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+a) Give prominent notice with each copy of the Combined Work that
+the Library is used in it and that the Library and its use are
+covered by this License.
+
+b) Accompany the Combined Work with a copy of the GNU GPL and this license
+document.
+
+c) For a Combined Work that displays copyright notices during
+execution, include the copyright notice for the Library among
+these notices, as well as a reference directing the user to the
+copies of the GNU GPL and this license document.
+
+d) Do one of the following:
+
+0) Convey the Minimal Corresponding Source under the terms of this
+License, and the Corresponding Application Code in a form
+suitable for, and under terms that permit, the user to
+recombine or relink the Application with a modified version of
+the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying
+Corresponding Source.
+
+1) Use a suitable shared library mechanism for linking with the
+Library.  A suitable mechanism is one that (a) uses at run time
+a copy of the Library already present on the user's computer
+system, and (b) will operate properly with a modified version
+of the Library that is interface-compatible with the Linked
+Version.
+
+e) Provide Installation Information, but only if you would otherwise
+be required to provide such information under section 6 of the
+GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the
+Combined Work produced by recombining or relinking the
+Application with a modified version of the Linked Version. (If
+you use option 4d0, the Installation Information must accompany
+the Minimal Corresponding Source and Corresponding Application
+Code. If you use option 4d1, you must provide the Installation
+Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based
+on the Library, uncombined with any other library facilities,
+conveyed under the terms of this License.
+
+b) Give prominent notice with the combined library that part of it
+is a work based on the Library, and explaining where to find the
+accompanying uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

bdbox-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: bdbox
+Version: 0.1.0
+Summary: build123d utilities box
+Project-URL: Homepage, https://smkent.github.io/bdbox
+Project-URL: Repository, https://github.com/smkent/bdbox
+Project-URL: Issues, https://github.com/smkent/bdbox/issues
+Author-email: Stephen Kent <smkent@smkent.net>
+License-Expression: LGPL-3.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# bdbox
+
+build123d utilities box
+
+[![License](https://img.shields.io/github/license/smkent/bdbox)](https://github.com/smkent/bdbox/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/bdbox)](https://pypi.org/project/bdbox/)
+[![Python](https://img.shields.io/pypi/pyversions/bdbox)](https://pypi.org/project/bdbox/)
+[![CI](https://github.com/smkent/bdbox/actions/workflows/ci.yaml/badge.svg)](https://github.com/smkent/bdbox/actions/workflows/ci.yaml)
+[![Coverage](https://codecov.io/gh/smkent/bdbox/branch/main/graph/badge.svg)](https://codecov.io/gh/smkent/bdbox)
+[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?logo=renovatebot)](https://renovatebot.com)
+[![GitHub stars](https://img.shields.io/github/stars/smkent/bdbox?style=social)](https://github.com/smkent/bdbox)
+
+## Installation
+
+```sh
+pip install bdbox
+```

bdbox-0.1.0/README.md

@@ -0,0 +1,17 @@
+# bdbox
+
+build123d utilities box
+
+[![License](https://img.shields.io/github/license/smkent/bdbox)](https://github.com/smkent/bdbox/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/bdbox)](https://pypi.org/project/bdbox/)
+[![Python](https://img.shields.io/pypi/pyversions/bdbox)](https://pypi.org/project/bdbox/)
+[![CI](https://github.com/smkent/bdbox/actions/workflows/ci.yaml/badge.svg)](https://github.com/smkent/bdbox/actions/workflows/ci.yaml)
+[![Coverage](https://codecov.io/gh/smkent/bdbox/branch/main/graph/badge.svg)](https://codecov.io/gh/smkent/bdbox)
+[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?logo=renovatebot)](https://renovatebot.com)
+[![GitHub stars](https://img.shields.io/github/stars/smkent/bdbox?style=social)](https://github.com/smkent/bdbox)
+
+## Installation
+
+```sh
+pip install bdbox
+```

bdbox-0.1.0/bdbox/__init__.py

@@ -0,0 +1,9 @@
+"""build123d utilities box."""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as import_version
+
+try:
+    version = import_version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    version = "0.0.0"

bdbox-0.1.0/docs/api.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: bdbox

bdbox-0.1.0/docs/contributing.md

@@ -0,0 +1,6 @@
+---
+title: Contributing
+icon: lucide/code
+---
+
+--8<-- "CONTRIBUTING.md"

bdbox-0.1.0/docs/development/requirements.md

@@ -0,0 +1,24 @@
+---
+title: Required software
+icon: lucide/bookmark-check
+---
+
+# Prerequisites
+
+- [x] A [supported version][python-versions] of [**Python**][python]
+- [x] [**git** for verson control][git]
+- [x] [Astral's **uv** Python project manager][uv]: `pip install uv` or
+  [other supported method][uv-installation]
+- [x] [**Copier**][copier]: `uv tool install copier`
+- [x] [Poe the Poet][poethepoet] (recommended): `uv tool install poethepoet`
+
+    This provides `poe` without the `uv run` prefix,
+    e.g. `poe test` instead of `uv run poe test`
+
+[copier]: https://copier.readthedocs.io
+[git]: https://git-scm.com
+[poethepoet]: https://poethepoet.natn.io/
+[python-versions]: https://devguide.python.org/versions/
+[python]: https://python.org
+[uv-installation]: https://docs.astral.sh/uv/getting-started/installation/
+[uv]: https://docs.astral.sh/uv/

bdbox-0.1.0/docs/development/updates.md

@@ -0,0 +1,33 @@
+---
+title: Template updates
+icon: lucide/git-merge
+---
+
+# Applying copier-python template updates
+
+Copier can update your project with template changes that have occurred since
+the project was created.
+
+To apply updates, simply run in your project directory:
+
+```sh
+copier update
+```
+
+This will repeat the setup prompts, in case any prompts have been added or
+changed.
+
+!!! tip
+    To change template-provided features in your project, simply change your
+    answers in the update prompts.
+
+To apply updates without being prompted (reusing all previous answers), run:
+
+```sh
+copier update -l
+```
+
+When `copier update` is finished, view changes with `git status` and `git diff`.
+Resolve any conflicts, and then commit the result.
+
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/

bdbox-0.1.0/docs/development/workflow.md

@@ -0,0 +1,42 @@
+---
+title: Development workflow
+icon: lucide/braces
+---
+
+# Project development workflow
+
+## Cloning the repository
+
+```sh
+git clone https://github.com/smkent/bdbox
+cd bdbox
+```
+
+Run `poe setup` in new repository clones to enable git hooks:
+
+```sh
+poe setup  # Enables git hooks
+```
+
+## Development tools
+
+* `poe lint`: Run formatters and static checks
+* `poe test`: Run tests
+
+The `lint` and `test` tasks can also be run as a single combined command with:
+
+```sh
+poe lt
+```
+
+## Documentation server
+
+Start the development server with:
+
+```sh
+poe docs
+```
+
+The documentation site will be served at **<http://localhost:8000>**.
+
+To use a different bind host/port, run `poe --help docs` for arguments info.

bdbox-0.1.0/docs/index.md

@@ -0,0 +1,8 @@
+---
+title: Overview
+icon: lucide/book-open
+hide:
+  - path
+---
+
+--8<-- "README.md"

bdbox-0.1.0/docs/license.md

@@ -0,0 +1,10 @@
+---
+title: License
+icon: lucide/scale
+---
+
+# License
+
+```
+--8<-- "LICENSE"
+```

bdbox-0.1.0/docs/releasing.md

@@ -0,0 +1,32 @@
+---
+title: Releasing a new version
+icon: lucide/rocket
+---
+
+# Releasing a new version
+
+Release version numbers should follow [Semantic Versioning][semver].
+
+To create a new release, simply create and push a tag with the new release
+version number:
+
+```sh
+git tag vX.Y.Z  # for example, v1.2.3
+git push --tags
+```
+
+* A corresponding [GitHub release][github-releases]
+  will be created automatically.
+
+    [![GitHub Release][github-release-badge]][github-release-latest]
+
+* A release package will be built and [uploaded to PyPI][pypi-project].
+
+    [![PyPI][pypi-badge]][pypi-project]
+
+[github-release-badge]: https://img.shields.io/github/v/release/smkent/bdbox
+[github-release-latest]: https://github.com/smkent/bdbox/releases/latest
+[github-releases]: https://github.com/smkent/bdbox/releases
+[pypi-badge]: https://img.shields.io/pypi/v/bdbox
+[pypi-project]: https://pypi.org/project/bdbox/
+[semver]: https://semver.org/

bdbox-0.1.0/docs/setup.md

@@ -0,0 +1,62 @@
+---
+title: One time setup
+icon: lucide/package-plus
+---
+
+# One time setup
+
+These steps only need to be completed once after the project is first created.
+
+## GitHub repository
+
+[Settings → General][repo-settings]:
+
+- [x] Allow merge commits
+- [ ] Allow squash merging
+- [ ] Allow rebase merging
+- [x] Automatically delete head branches
+
+[Settings → Branches][repo-settings-branches] → Add branch protection rule
+for the Default branch (`main`):
+
+- [x] Restrict deletions
+- [x] Require a pull request before merging
+- [x] Block force pushes
+
+## Renovate
+
+Ensure the [Renovate app][renovate] is installed on your account, then
+enable it for `smkent/bdbox`.
+
+## PyPI publishing
+
+This project uses [trusted publishing][pypi-trusted-publishing] so no API tokens
+need to be stored as secrets.
+
+1. On PyPI, add a (pending) trusted publisher in your
+   [Trusted Publisher Management][pypi-publishing-settings] settings:
+     - Publisher: GitHub Actions
+     - Owner: `smkent`
+     - Repository: `bdbox`
+     - Workflow: `release.yaml`
+     - Environment: `pypi`
+2. Create the `pypi` environment in the GitHub repository:
+   [Settings → Environments][repo-settings-envs] → New environment → `pypi`
+3. Publish a release by pushing a tag:
+   ```sh
+   git tag v0.1.0  # or your desired first version number
+   git push --tags
+   ```
+
+## GitHub Pages
+
+[Settings → Pages][repo-settings-pages] → Source → GitHub Actions
+
+[pypi-publishing-settings]: https://pypi.org/manage/account/publishing/
+[pypi-trusted-publishing]: https://docs.pypi.org/trusted-publishers/
+[renovate]: https://github.com/apps/renovate
+[repo-releases]: https://github.com/smkent/bdbox/releases
+[repo-settings]: https://github.com/smkent/bdbox/settings
+[repo-settings-envs]: https://github.com/smkent/bdbox/settings/environments
+[repo-settings-branches]: https://github.com/smkent/bdbox/settings/branches
+[repo-settings-pages]: https://github.com/smkent/bdbox/settings/pages

bdbox-0.1.0/pyproject.toml

@@ -0,0 +1,215 @@
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bdbox"
+dynamic = ["version"]
+description = "build123d utilities box"
+readme = "README.md"
+license = "LGPL-3.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [
+    { name = "Stephen Kent", email = "smkent@smkent.net" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Documentation",
+    "Topic :: Software Development",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+keywords = []
+dependencies = []
+
+[project.urls]
+Homepage = "https://smkent.github.io/bdbox"
+Repository = "https://github.com/smkent/bdbox"
+Issues = "https://github.com/smkent/bdbox/issues"
+
+[dependency-groups]
+dev = [
+    "poethepoet>=0.42",
+    "prek>=0.3",
+    "pysentry-rs>=0.4",
+    "pytest>=9.0",
+    "pytest-cov>=7.0",
+    "pytest-sugar>=1.0",
+    "ruff>=0.15",
+    "ty>=0.0.26",
+]
+docs = [
+    "mkdocstrings[python]>=1",
+    "zensical>=0.0.30",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["/bdbox", "/tests", "*.md", "LICENSE"]
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.poe.executor]
+type = "uv"
+
+[tool.poe.tasks.audit]
+cmd = "pysentry-rs"
+help = "Run dependencies security audit"
+
+[tool.poe.tasks.build]
+cmd = "uv build"
+help = "Build distribution package"
+
+[tool.poe.tasks.docs-build]
+cmd = "zensical build -c"
+help = "Build documentation site"
+
+[tool.poe.tasks.docs]
+sequence = [
+    {ref = "docs-build"},
+    {cmd = "zensical serve -a \"${host}:${port}\""},
+]
+help = "Run documentation site locally"
+
+[tool.poe.tasks.docs.args.host]
+options = ['--host', '-h']
+help = "Bind IP"
+default = "localhost"
+
+[tool.poe.tasks.docs.args.port]
+positional = true
+help = "Bind Port"
+default = "8000"
+
+[tool.poe.tasks.init]
+sequence = [
+    {shell = "[ ! -d .git ] || { echo \"git repository already exists\"; exit 1; }"},
+    {cmd = "git init"},
+    {ref = "setup"},
+    {cmd = "git remote add origin https://github.com/smkent/bdbox"},
+    {cmd = "git config --local remote.origin.pushurl git@github.com:smkent/bdbox.git"},
+    {cmd = "git add ."},
+    {cmd = "git commit -m 'Create project from template'"},
+]
+help = "Initialize git repository once on project creation"
+
+[tool.poe.tasks.lint]
+cmd = "prek run --all-files"
+help = "Run all formatters and static checks"
+
+[tool.poe.tasks.lt]
+sequence = [{ref = "lint"}, {ref = "test"}]
+help = "Run all formatters, static checks and tests"
+
+[tool.poe.tasks.setup]
+sequence = [
+    {cmd = "uv sync"},
+    {cmd = "prek install"},
+]
+help = "Install project dependencies and git hooks"
+
+[tool.poe.tasks.test]
+cmd = "pytest"
+help = "Run tests"
+
+[tool.poe.tasks.test-versions]
+sequence = ["test-py310", "test-py311", "test-py312", "test-py313", "test-py314"]
+help = "Run tests across all Python versions"
+
+[tool.poe.tasks.test-py310]
+cmd = "pytest"
+executor = {isolated = true, python = "3.10"}
+help = "Run tests using Python 3.10"
+
+[tool.poe.tasks.test-py311]
+cmd = "pytest"
+executor = {isolated = true, python = "3.11"}
+help = "Run tests using Python 3.11"
+
+[tool.poe.tasks.test-py312]
+cmd = "pytest"
+executor = {isolated = true, python = "3.12"}
+help = "Run tests using Python 3.12"
+
+[tool.poe.tasks.test-py313]
+cmd = "pytest"
+executor = {isolated = true, python = "3.13"}
+help = "Run tests using Python 3.13"
+
+[tool.poe.tasks.test-py314]
+cmd = "pytest"
+executor = {isolated = true, python = "3.14"}
+help = "Run tests using Python 3.14"
+
+[tool.pytest]
+addopts = [
+    "-ra",
+    "--cov",
+    "--strict-config",
+    "--strict-markers",
+]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["bdbox"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]
+
+[tool.ruff]
+line-length = 79
+output-format = "concise"
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
+    "COM812",  # Trailing comma missing
+    "D1",  # Missing docstring presence rules
+    "EM",  # flake8-errmsg
+    "G004",  # Logging statement uses f-string
+    "PLR",  # pylint Refactor
+    "S607",  # Starting a process with a partial executable path
+    "TD",  # flake8-todos
+    "TRY003", # Avoid specifying long messages outside the exception class
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["bdbox"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "ARG",  # flake8-unused-arguments
+    "S101",  # Use of assert detected
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ty.terminal]
+error-on-warning = true
+output-format = "concise"
+
+[tool.uv]
+default-groups = ["dev", "docs"]
+
+[tool.uv-dynamic-versioning]
+pattern = "default-unprefixed"
+fallback-version = "0.0.0"

bdbox-0.1.0/tests/test_version.py

@@ -0,0 +1,5 @@
+import bdbox
+
+
+def test_version() -> None:
+    assert bdbox.version