atheneum-forge 1.0.0__tar.gz

atheneum_forge-1.0.0/.gitignore

@@ -0,0 +1,27 @@
+build/
+dist/
+*.egg*/
+atheneum_forge/_version.py
+
+.doit.*
+
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+__pycache__/
+
+.vscode/
+
+.venv/
+venv/
+
+*.bak
+*.bak/
+
+*.log
+*.theirs
+*.ours
+
+todo.md
+# TODO: mkdocs build files
+# TODO: sphinx build files

atheneum_forge-1.0.0/LICENSE.txt

@@ -0,0 +1,11 @@
+Copyright (c) 2025 Big Ladder Software, LLC
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

atheneum_forge-1.0.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: atheneum-forge
+Version: 1.0.0
+Summary: Project boilerplate and build system scaffolding generation and maintenance.
+Author-email: Big Ladder Software <info@bigladdersoftware.com>
+License-File: LICENSE.txt
+Requires-Python: >=3.10
+Requires-Dist: click<8.2.0
+Requires-Dist: jinja2<4,>=3.1.4
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: textual
+Requires-Dist: tomli-w<2,>=1.1.0
+Requires-Dist: typer<0.13,>=0.12.5
+Requires-Dist: yamlcore
+Description-Content-Type: text/markdown
+
+# Atheneum Forge
+
+This project is a boiler-plate generator.
+In contrast to a static template, the main ideas of the project are to:
+
+- not only be able to generate a "scaffolding" for a new (or existing) project
+- but **ALSO** be able to keep that "scaffolding" up-to-date based on an authoratative source
+- and also automate several project-level tasks such as:
+    - version updating
+    - checking submodules (fmt, google test, courier) to see if there are newer versions and automating their update
+    - adding copyright headers
+    - automating the addition of "include guards" (for C++)
+
+
+## Usage
+
+### From Github
+Atheneum-forge can be run as an executable directly from Github, with the [uv dependency manager](https://docs.astral.sh/uv/getting-started/installation/):
+
+```
+> uvx --from git+https://github.com/bigladder/atheneum-forge.git forge-cli init . <project_name> --type <cpp | python>
+```
+or
+```
+> uvx --from git+https://github.com/bigladder/atheneum-forge.git forge
+```
+
+### From a clone
+The atheneum-forge tool can be used directly from the repository directory, or built into a package.The project is managed with the uv depenency manager; to build, simply use command "uv build" from the atheneum-forge top directory.
+
+Installing the atheneum-forge package will provide two command-line tools: a TUI (text user interface) and a command-line-app.
+
+* _forge-cli_ allows the user to view all project-generation functionality at a glance;
+
+* _forge_ can be called with arguments to implement one piece of functionality at a time (_forge --help_).
+
+Project generation consists of two steps, which may be combined. First, a configuration file is generated (forge.toml), which contains default settings such as the project name and type. If more detailed defaults are desired, the _forge.toml_ file contains project-relevant settings that can be activated by removing the comment character. The project-generation step will automatically import these settings to populate project files (primarily support and build files).
+
+>**Note**
+>
+>On some Windows PCs, the forge TUI may render with unexpected characters. For a cleaner experience, download and [install](https://support.microsoft.com/en-us/office/add-a-font-b7c5f17c-4426-4b53-967f-455339c564c1) a [Nerd Font](https://www.nerdfonts.com/font-downloads) (such as FiraCode).
+
+### As a Python package
+
+_atheneum-forge_ may be imported as a package dependency directly from git. Include atheneum-forge in your pyproject.toml dependencies list, and set the source as below:
+```
+[tool.uv.sources]
+atheneum-forge = { git = "https://github.com/bigladder/atheneum-forge" }
+```
+
+In your code,
+
+    from atheneum_forge import forge, project_factory
+
+to use the public interface.
+
+## For developers
+
+For each language to be supported by a project template, the _languages_ directory contains a <language_name> entry. Currently C++ and Python are supported. Each language pack consists of three conceptual pieces:
+
+**Project directory tree**
+
+The canonical folder structure for open-source projects, with any standard, non-customizable files that are simply copied into a new project.
+
+**Templates**:
+
+Files within the folder structure that must be customized (e.g. with the project name) are stored as Jinja templates with a .j2 extension. These are rendered using default parameter values before being copied into a new project.
+
+**manifest.toml**: provides parameters and indications of how files in the template repository should be used
+
+The manifest is a complete description of every file that comprises a project scaffold. Its sections are:
+* _static_: a list of files or directories to be copied directly
+* _template_: a list of files that will be modified before copying
+* _template-parameters_: a list of substitution parameters for the templates
+* _deps_: a set of dictionaries describing submodule dependencies
+
+
+TODO: Format of manifest, to/from options, extra keywords
+
+
+## Reference
+
+Poetry and Helix -- how to bring the Helix editor into context with a Python app being developed
+https://blog.jorisl.nl/helix_python_lsp/

atheneum_forge-1.0.0/README.md

@@ -0,0 +1,84 @@
+# Atheneum Forge
+
+This project is a boiler-plate generator.
+In contrast to a static template, the main ideas of the project are to:
+
+- not only be able to generate a "scaffolding" for a new (or existing) project
+- but **ALSO** be able to keep that "scaffolding" up-to-date based on an authoratative source
+- and also automate several project-level tasks such as:
+    - version updating
+    - checking submodules (fmt, google test, courier) to see if there are newer versions and automating their update
+    - adding copyright headers
+    - automating the addition of "include guards" (for C++)
+
+
+## Usage
+
+### From Github
+Atheneum-forge can be run as an executable directly from Github, with the [uv dependency manager](https://docs.astral.sh/uv/getting-started/installation/):
+
+```
+> uvx --from git+https://github.com/bigladder/atheneum-forge.git forge-cli init . <project_name> --type <cpp | python>
+```
+or
+```
+> uvx --from git+https://github.com/bigladder/atheneum-forge.git forge
+```
+
+### From a clone
+The atheneum-forge tool can be used directly from the repository directory, or built into a package.The project is managed with the uv depenency manager; to build, simply use command "uv build" from the atheneum-forge top directory.
+
+Installing the atheneum-forge package will provide two command-line tools: a TUI (text user interface) and a command-line-app.
+
+* _forge-cli_ allows the user to view all project-generation functionality at a glance;
+
+* _forge_ can be called with arguments to implement one piece of functionality at a time (_forge --help_).
+
+Project generation consists of two steps, which may be combined. First, a configuration file is generated (forge.toml), which contains default settings such as the project name and type. If more detailed defaults are desired, the _forge.toml_ file contains project-relevant settings that can be activated by removing the comment character. The project-generation step will automatically import these settings to populate project files (primarily support and build files).
+
+>**Note**
+>
+>On some Windows PCs, the forge TUI may render with unexpected characters. For a cleaner experience, download and [install](https://support.microsoft.com/en-us/office/add-a-font-b7c5f17c-4426-4b53-967f-455339c564c1) a [Nerd Font](https://www.nerdfonts.com/font-downloads) (such as FiraCode).
+
+### As a Python package
+
+_atheneum-forge_ may be imported as a package dependency directly from git. Include atheneum-forge in your pyproject.toml dependencies list, and set the source as below:
+```
+[tool.uv.sources]
+atheneum-forge = { git = "https://github.com/bigladder/atheneum-forge" }
+```
+
+In your code,
+
+    from atheneum_forge import forge, project_factory
+
+to use the public interface.
+
+## For developers
+
+For each language to be supported by a project template, the _languages_ directory contains a <language_name> entry. Currently C++ and Python are supported. Each language pack consists of three conceptual pieces:
+
+**Project directory tree**
+
+The canonical folder structure for open-source projects, with any standard, non-customizable files that are simply copied into a new project.
+
+**Templates**:
+
+Files within the folder structure that must be customized (e.g. with the project name) are stored as Jinja templates with a .j2 extension. These are rendered using default parameter values before being copied into a new project.
+
+**manifest.toml**: provides parameters and indications of how files in the template repository should be used
+
+The manifest is a complete description of every file that comprises a project scaffold. Its sections are:
+* _static_: a list of files or directories to be copied directly
+* _template_: a list of files that will be modified before copying
+* _template-parameters_: a list of substitution parameters for the templates
+* _deps_: a set of dictionaries describing submodule dependencies
+
+
+TODO: Format of manifest, to/from options, extra keywords
+
+
+## Reference
+
+Poetry and Helix -- how to bring the Helix editor into context with a Python app being developed
+https://blog.jorisl.nl/helix_python_lsp/

atheneum_forge-1.0.0/atheneum_forge/__init__.py

@@ -0,0 +1,2 @@
+from atheneum_forge import logging_setup
+from atheneum_forge._version import __version__

atheneum_forge-1.0.0/atheneum_forge/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)
+
+__commit_id__ = commit_id = None

atheneum_forge-1.0.0/atheneum_forge/copyright.j2

@@ -0,0 +1,2 @@
+{{ comment_characters }} SPDX-FileCopyrightText: © {{ start_year }} {{ name_of_copyright_holder }} <{{ contact_email }}>
+{{ comment_characters }} SPDX-License-Identifier: {{ SPDX_license_name }}