omurtag 0.4.1__tar.gz

omurtag-0.4.1/LICENSE

@@ -0,0 +1,13 @@
+The 3-Clause BSD License
+
+Copyright 2026 Evgeni Genchev
+
+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.

omurtag-0.4.1/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: omurtag
+Version: 0.4.1
+Summary: Scaffold projects from personal templates, with a security audit on every create
+License: BSD-3-Clause
+Project-URL: Homepage, https://evgeni-genchev.com/omurtag/
+Project-URL: Source, https://github.com/EvgeniGenchev/omurtag
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Environment :: Console
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gitpython>=3.1.46
+Requires-Dist: rich-argparse>=1.7.2
+Requires-Dist: tqdm>=4.67.3
+Requires-Dist: requests>=2.32.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: tomli>=2.0.0; python_version < "3.11"
+Dynamic: license-file
+
+# omurtag
+
+A builder for a builder. Scaffold projects from personal templates, with a security audit on every create.
+
+## Install
+
+```bash
+curl -fsSL https://evgeni-genchev.com/omurtag/install.sh | sh
+```
+
+Or directly:
+
+```bash
+uv tool install omurtag
+# or
+pip install omurtag
+```
+
+If `omurtag` is not found after installing:
+
+```bash
+uv tool update-shell
+```
+
+## Commands
+
+```
+omurtag {add,remove,create,list,pull,sync,search}
+
+  add      Add a local folder as a template
+  remove   Remove a template by name
+  create   Generate a project from a template
+  list     List templates with stack info
+  pull     Pull a template from a git repo
+  sync     Download/update all templates from config
+  search   Browse and pull from the community template list
+```
+
+### Examples
+
+```bash
+# browse community templates and pull interactively
+omurtag search
+
+# pull a template from GitHub
+omurtag pull github:EvgeniGenchev/fastapi_frontend_omurtag_template
+
+# pull a specific branch
+omurtag pull github:user/repo_omurtag_template --branch dev
+
+# list available templates
+omurtag list
+omurtag list --verbose
+
+# create a project (interactive if no args)
+omurtag create
+omurtag create ~/projects/myapp --type fastapi_frontend
+
+# add a local folder as a template
+omurtag add ~/my_template_folder
+
+# remove a template
+omurtag remove fastapi_frontend
+
+# sync all templates from config
+omurtag sync
+```
+
+## Configuration
+
+Config file location: `$XDG_CONFIG_HOME/omurtag/config.py` or `~/.omurtag/config.py`
+
+```python
+templates = [
+    "github:EvgeniGenchev/fastapi_frontend_omurtag_template",
+    "gitlab:user/my_project_omurtag_template",
+    "codeberg.org:user/tool_omurtag_template",
+    "https://codeberg.org/user/repo_omurtag_template.git",
+]
+
+# optional
+transitive_deps = False  # scan transitive deps on create (slower)
+show_desc  = True        # show description in list
+show_stack = True        # show stack in list
+```
+
+## Creating templates
+
+Any folder can be a template. Use `omurtag add <folder>` to register a local one. To host it so others can pull it, name the repo with a `_omurtag_template` suffix.
+
+**Placeholders** use the `<*name*>` syntax. On `omurtag create`, every placeholder is replaced in file contents, filenames, and directory names. `<*project*>` is always set to the project name. Any other placeholders are prompted for interactively at create time.
+
+**Security audit** runs automatically on every `create`. omurtag detects the stack from marker files (`pyproject.toml`, `package.json`, `Cargo.toml`, etc.) and checks direct dependencies for known CVEs via [deps.dev](https://deps.dev). Opt in to transitive scanning with `transitive_deps = True` in config.
+
+An optional **`omurtag.sh`** at the template root is a post-create setup script. After the project is created, omurtag shows its contents and asks whether to run it in the project directory. It is never copied into created projects.
+
+An optional **`omurtag.toml`** at the template root provides metadata shown in `omurtag list`. It is never copied into created projects.
+
+```toml
+[template]
+name        = "my-service"
+description = "Minimal Python service"
+stack       = ["python"]
+author      = "you"
+```
+
+## Available templates
+
+- [fastapi-frontend](https://github.com/EvgeniGenchev/fastapi_frontend_omurtag_template) — FastAPI backend with Jinja2 HTML frontend
+- [jupyter-notebook](https://github.com/EvgeniGenchev/jupyter_notebook_omurtag_template) — Jupyter notebook project with uv
+- [neovim-plugin](https://github.com/EvgeniGenchev/neovim_plugin_omurtag_template) — Neovim plugin boilerplate
+- [tool-website](https://github.com/EvgeniGenchev/tool_website_omurtag_template) — Single-page tool website with docs, about, and donate pages
+- [static-html-website](https://github.com/EvgeniGenchev/static_html_website_omurtag_template) — Static HTML/CSS website
+- [typst-coursework](https://github.com/grexdin/typst_coursework_omurtag_template) — Typst coursework document template
+
+Full list: [evgeni-genchev.com/omurtag/templates.json](https://evgeni-genchev.com/omurtag/templates.json)
+
+---
+
+## Dev install
+
+```bash
+uv cache clean && uv tool uninstall omurtag && uv tool install .
+```
+
+## License
+
+[WTFPL](http://www.wtfpl.net)

omurtag-0.4.1/README.md

@@ -0,0 +1,128 @@
+# omurtag
+
+A builder for a builder. Scaffold projects from personal templates, with a security audit on every create.
+
+## Install
+
+```bash
+curl -fsSL https://evgeni-genchev.com/omurtag/install.sh | sh
+```
+
+Or directly:
+
+```bash
+uv tool install omurtag
+# or
+pip install omurtag
+```
+
+If `omurtag` is not found after installing:
+
+```bash
+uv tool update-shell
+```
+
+## Commands
+
+```
+omurtag {add,remove,create,list,pull,sync,search}
+
+  add      Add a local folder as a template
+  remove   Remove a template by name
+  create   Generate a project from a template
+  list     List templates with stack info
+  pull     Pull a template from a git repo
+  sync     Download/update all templates from config
+  search   Browse and pull from the community template list
+```
+
+### Examples
+
+```bash
+# browse community templates and pull interactively
+omurtag search
+
+# pull a template from GitHub
+omurtag pull github:EvgeniGenchev/fastapi_frontend_omurtag_template
+
+# pull a specific branch
+omurtag pull github:user/repo_omurtag_template --branch dev
+
+# list available templates
+omurtag list
+omurtag list --verbose
+
+# create a project (interactive if no args)
+omurtag create
+omurtag create ~/projects/myapp --type fastapi_frontend
+
+# add a local folder as a template
+omurtag add ~/my_template_folder
+
+# remove a template
+omurtag remove fastapi_frontend
+
+# sync all templates from config
+omurtag sync
+```
+
+## Configuration
+
+Config file location: `$XDG_CONFIG_HOME/omurtag/config.py` or `~/.omurtag/config.py`
+
+```python
+templates = [
+    "github:EvgeniGenchev/fastapi_frontend_omurtag_template",
+    "gitlab:user/my_project_omurtag_template",
+    "codeberg.org:user/tool_omurtag_template",
+    "https://codeberg.org/user/repo_omurtag_template.git",
+]
+
+# optional
+transitive_deps = False  # scan transitive deps on create (slower)
+show_desc  = True        # show description in list
+show_stack = True        # show stack in list
+```
+
+## Creating templates
+
+Any folder can be a template. Use `omurtag add <folder>` to register a local one. To host it so others can pull it, name the repo with a `_omurtag_template` suffix.
+
+**Placeholders** use the `<*name*>` syntax. On `omurtag create`, every placeholder is replaced in file contents, filenames, and directory names. `<*project*>` is always set to the project name. Any other placeholders are prompted for interactively at create time.
+
+**Security audit** runs automatically on every `create`. omurtag detects the stack from marker files (`pyproject.toml`, `package.json`, `Cargo.toml`, etc.) and checks direct dependencies for known CVEs via [deps.dev](https://deps.dev). Opt in to transitive scanning with `transitive_deps = True` in config.
+
+An optional **`omurtag.sh`** at the template root is a post-create setup script. After the project is created, omurtag shows its contents and asks whether to run it in the project directory. It is never copied into created projects.
+
+An optional **`omurtag.toml`** at the template root provides metadata shown in `omurtag list`. It is never copied into created projects.
+
+```toml
+[template]
+name        = "my-service"
+description = "Minimal Python service"
+stack       = ["python"]
+author      = "you"
+```
+
+## Available templates
+
+- [fastapi-frontend](https://github.com/EvgeniGenchev/fastapi_frontend_omurtag_template) — FastAPI backend with Jinja2 HTML frontend
+- [jupyter-notebook](https://github.com/EvgeniGenchev/jupyter_notebook_omurtag_template) — Jupyter notebook project with uv
+- [neovim-plugin](https://github.com/EvgeniGenchev/neovim_plugin_omurtag_template) — Neovim plugin boilerplate
+- [tool-website](https://github.com/EvgeniGenchev/tool_website_omurtag_template) — Single-page tool website with docs, about, and donate pages
+- [static-html-website](https://github.com/EvgeniGenchev/static_html_website_omurtag_template) — Static HTML/CSS website
+- [typst-coursework](https://github.com/grexdin/typst_coursework_omurtag_template) — Typst coursework document template
+
+Full list: [evgeni-genchev.com/omurtag/templates.json](https://evgeni-genchev.com/omurtag/templates.json)
+
+---
+
+## Dev install
+
+```bash
+uv cache clean && uv tool uninstall omurtag && uv tool install .
+```
+
+## License
+
+[WTFPL](http://www.wtfpl.net)

omurtag-0.4.1/omurtag/__init__.py

@@ -0,0 +1,4 @@
+from .commands import run
+from .utils import create_directory, get_data_directory
+
+__all__ = ["run", "create_directory", "get_data_directory"]

omurtag-0.4.1/omurtag/__main__.py

@@ -0,0 +1,131 @@
+import argparse
+from rich.console import Console
+from rich import print
+from rich_argparse import RichHelpFormatter
+from omurtag import run
+
+PROG = "omurtag"
+DESCRIPTION = """
+omurtag is a tool that helps you create projects from templates
+"""
+RichHelpFormatter.console = Console(force_terminal=True)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog=PROG,
+        formatter_class=RichHelpFormatter,
+        description=DESCRIPTION,
+    )
+    parser.add_argument("-v","--version", action="store_true")
+
+    subparsers = parser.add_subparsers(dest="mode")
+
+    # -- add mode --
+    add_parser = subparsers.add_parser(
+        "add",
+        help="Add new template folder",
+        formatter_class=RichHelpFormatter,
+    )
+    add_parser.add_argument(
+        "input_file",
+        type=str,
+        help="Your project dependency template",
+    )
+
+    # -- remove mode --
+    remove_parser = subparsers.add_parser(
+        "remove",
+        help="Remove a template folder",
+        formatter_class=RichHelpFormatter,
+    )
+    remove_parser.add_argument(
+        "template_name",
+        type=str,
+        help="Remove the provided template from the list",
+    )
+
+    # -- create mode --
+    create_parser = subparsers.add_parser(
+        "create",
+        help="Generate a project based on an available template",
+        formatter_class=RichHelpFormatter,
+    )
+    create_parser.add_argument(
+        "project_name", type=str, help="Your project name", nargs="?"
+    )
+
+    create_parser.add_argument(
+        "-t",
+        "--type",
+        type=str,
+        help='Project type you want to generate. If unsure what projects are supported use "omurtag list"',
+        required=False,
+        default=None,
+    )
+
+    # -- list mode --
+    list_parser = subparsers.add_parser(
+        "list",
+        help="List template names and their technology stack, if present",
+        formatter_class=RichHelpFormatter,
+    )
+    list_parser.add_argument("--verbose", action="store_true")
+
+    # -- pull mode --
+    pull_parser = subparsers.add_parser(
+        "pull",
+        help="Pull a template from a git repository and add it to your local templates",
+        formatter_class=RichHelpFormatter,
+    )
+    pull_parser.add_argument(
+        "-b",
+        "--branch",
+        type=str,
+        help="The branch of the template git repo.",
+        required=False,
+        default=None,
+    )
+
+    pull_parser.add_argument(
+        "link",
+        type=str,
+        help="The http link of the template git repo.",
+    )
+
+    pull_parser.add_argument(
+        "-r",
+        "--recursive",
+        action="store_true",
+    )
+
+    # -- sync mode --
+    subparsers.add_parser(
+        "sync",
+        help="Downlaod/Update all the template repositories mentioned in the config file.",
+        formatter_class=RichHelpFormatter,
+    )
+
+    # -- search mode --
+    subparsers.add_parser(
+        "search",
+        help="Browse and pull templates from the community list.",
+        formatter_class=RichHelpFormatter,
+    )
+
+    args = parser.parse_args()
+
+    if not args.version and args.mode is None:
+        parser.error("a mode is required")
+
+    if args.version:
+        version = __import__("importlib").metadata.version("omurtag")
+        print(f"[blue]V{version}[/blue]")
+
+        exit(0)
+
+    run(args)
+
+
+if __name__ == "__main__":
+    main()