broskill 0.1.0__tar.gz

broskill-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # required for PyPI trusted publishing
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

broskill-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+MANIFEST
+
+# 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
+*.py.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/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

broskill-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

broskill-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 doublebank
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

broskill-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: broskill
+Version: 0.1.0
+Summary: Lightweight, quick-loading skill loader for agentic projects — discovers skills (SKILL.md + references/scripts/assets), loads their instructions, and turns their scripts into callable tools.
+Project-URL: Repository, https://github.com/datanooblol/broskill
+Project-URL: Changelog, https://github.com/datanooblol/broskill/blob/main/VERSIONS.md
+Author: datanooblol
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: pyyaml>=6.0.3
+Description-Content-Type: text/markdown
+
+# broskill
+
+yo. **broskill** is a lightweight, quick-loading skill loader for agentic projects — a "skill" being a folder with instructions (`SKILL.md`) plus optional reference docs, python scripts as tools, and static assets. broskill's whole job is finding those folders, loading them, and turning their scripts into callable tools. That's it. That's the lib.
+
+part of the **bro lib family** — small, opinionated, do-one-thing tools built to stop us from writing the same glue code every time we spin up a new agentic project.
+
+## why this exists
+
+every time you start a new agent project you end up rebuilding the same boring plumbing: some way to discover "skills," some way to load their instructions, some way to turn a script into a tool the model can call. broskill is that plumbing, ripped out of real projects where we got tired of writing it again and again.
+
+**heads up:** this is an opinionated lib. it works one way — SKILL.md + `references/` + `scripts/` + `assets/`, discovered off a `skills/` folder. if that convention fits your project, great, you just saved yourself a bunch of setup. if it doesn't, this probably isn't your lib, and that's fine — go build your own, that's basically how broskill got made in the first place. inspired by real work and real struggle. voilà, here it is.
+
+## install
+
+```bash
+uv pip install -e .
+```
+
+## the shape of a skill
+
+```
+skills/
+  read-file/
+    SKILL.md              # frontmatter (name, description, version, ...) + instructions
+    references/
+      script.md            # optional deep-dive docs, loaded on demand
+    scripts/
+      read_file.py          # a get_args()-based python script -> becomes a callable tool
+    assets/
+      template.md            # optional static files a skill hands out
+```
+
+`SKILL.md`'s frontmatter has to match the [`Skill`](src/broskill/data_specs/skill.py) dataclass field-for-field (`name`, `description`, `version` required; `tags`, `keywords`, `default`, `status` optional). Want to build one from scratch? There's a skill for that: [`skills/create-skill`](skills/create-skill/SKILL.md).
+
+## quick start
+
+### load skills — `SkillControl`
+
+```python
+from broskill.processing.path import find_root
+from broskill.processing.skill import SkillControl
+
+root = find_root()  # walks up 'til it finds a skills/ folder
+sc = SkillControl(root=root / "skills")
+
+for skill in sc.list_skills():
+    print(skill.name, "-", skill.description)
+
+body = sc.load_skill("read-file")          # -> SKILL.md's instructions, as a str
+ref = sc.load_skill_extension("read-file", "references/script.md")
+```
+
+Full runnable version: [`examples/case1.py`](examples/case1.py).
+
+### turn a script into a tool — `ToolControl`
+
+```python
+from broskill.processing.skill import SkillControl
+from broskill.processing.tool import ToolControl, to_args
+import subprocess, sys
+
+sc = SkillControl(root=root / "skills")
+sc.load_skill("read-file")
+
+tc = ToolControl(sc)
+tool = tc.load_tool("read-file", "scripts/list_files.py")
+# tool.name, tool.description, tool.args -> ready to hand to an LLM's tool schema
+
+result = subprocess.run(
+    [sys.executable, str(tool.path), *to_args({"path": "skills/**/*.md"})],
+    capture_output=True, text=True,
+)
+```
+
+A script only needs one thing to become a tool: a module-level `get_args()` returning an `argparse.ArgumentParser`. broskill reads that parser and builds the schema for you — no separate tool-definition file to keep in sync. See [`skills/create-skill/references/script.md`](skills/create-skill/references/script.md) for the full contract.
+
+Full runnable version: [`examples/case2.py`](examples/case2.py).
+
+## running the tests
+
+```bash
+uv run pytest
+uv run ruff check
+```
+
+## more
+
+- [`VERSIONS.md`](VERSIONS.md) — changelog
+- [`LICENSE`](LICENSE) — MIT
+- [`skills/create-skill`](skills/create-skill/SKILL.md) — a skill that helps you build more skills
+- [`skills/read-file`](skills/read-file/SKILL.md) — the skill used in both examples above, a decent reference for what a real skill looks like
+
+stay chill, ship skills. 🤙

broskill-0.1.0/README.md

@@ -0,0 +1,93 @@
+# broskill
+
+yo. **broskill** is a lightweight, quick-loading skill loader for agentic projects — a "skill" being a folder with instructions (`SKILL.md`) plus optional reference docs, python scripts as tools, and static assets. broskill's whole job is finding those folders, loading them, and turning their scripts into callable tools. That's it. That's the lib.
+
+part of the **bro lib family** — small, opinionated, do-one-thing tools built to stop us from writing the same glue code every time we spin up a new agentic project.
+
+## why this exists
+
+every time you start a new agent project you end up rebuilding the same boring plumbing: some way to discover "skills," some way to load their instructions, some way to turn a script into a tool the model can call. broskill is that plumbing, ripped out of real projects where we got tired of writing it again and again.
+
+**heads up:** this is an opinionated lib. it works one way — SKILL.md + `references/` + `scripts/` + `assets/`, discovered off a `skills/` folder. if that convention fits your project, great, you just saved yourself a bunch of setup. if it doesn't, this probably isn't your lib, and that's fine — go build your own, that's basically how broskill got made in the first place. inspired by real work and real struggle. voilà, here it is.
+
+## install
+
+```bash
+uv pip install -e .
+```
+
+## the shape of a skill
+
+```
+skills/
+  read-file/
+    SKILL.md              # frontmatter (name, description, version, ...) + instructions
+    references/
+      script.md            # optional deep-dive docs, loaded on demand
+    scripts/
+      read_file.py          # a get_args()-based python script -> becomes a callable tool
+    assets/
+      template.md            # optional static files a skill hands out
+```
+
+`SKILL.md`'s frontmatter has to match the [`Skill`](src/broskill/data_specs/skill.py) dataclass field-for-field (`name`, `description`, `version` required; `tags`, `keywords`, `default`, `status` optional). Want to build one from scratch? There's a skill for that: [`skills/create-skill`](skills/create-skill/SKILL.md).
+
+## quick start
+
+### load skills — `SkillControl`
+
+```python
+from broskill.processing.path import find_root
+from broskill.processing.skill import SkillControl
+
+root = find_root()  # walks up 'til it finds a skills/ folder
+sc = SkillControl(root=root / "skills")
+
+for skill in sc.list_skills():
+    print(skill.name, "-", skill.description)
+
+body = sc.load_skill("read-file")          # -> SKILL.md's instructions, as a str
+ref = sc.load_skill_extension("read-file", "references/script.md")
+```
+
+Full runnable version: [`examples/case1.py`](examples/case1.py).
+
+### turn a script into a tool — `ToolControl`
+
+```python
+from broskill.processing.skill import SkillControl
+from broskill.processing.tool import ToolControl, to_args
+import subprocess, sys
+
+sc = SkillControl(root=root / "skills")
+sc.load_skill("read-file")
+
+tc = ToolControl(sc)
+tool = tc.load_tool("read-file", "scripts/list_files.py")
+# tool.name, tool.description, tool.args -> ready to hand to an LLM's tool schema
+
+result = subprocess.run(
+    [sys.executable, str(tool.path), *to_args({"path": "skills/**/*.md"})],
+    capture_output=True, text=True,
+)
+```
+
+A script only needs one thing to become a tool: a module-level `get_args()` returning an `argparse.ArgumentParser`. broskill reads that parser and builds the schema for you — no separate tool-definition file to keep in sync. See [`skills/create-skill/references/script.md`](skills/create-skill/references/script.md) for the full contract.
+
+Full runnable version: [`examples/case2.py`](examples/case2.py).
+
+## running the tests
+
+```bash
+uv run pytest
+uv run ruff check
+```
+
+## more
+
+- [`VERSIONS.md`](VERSIONS.md) — changelog
+- [`LICENSE`](LICENSE) — MIT
+- [`skills/create-skill`](skills/create-skill/SKILL.md) — a skill that helps you build more skills
+- [`skills/read-file`](skills/read-file/SKILL.md) — the skill used in both examples above, a decent reference for what a real skill looks like
+
+stay chill, ship skills. 🤙

broskill-0.1.0/VERSIONS.md

@@ -0,0 +1,17 @@
+# VERSIONS
+
+Changelog for broskill. Newest first.
+
+## v0.1.0
+
+First real drop. This is where broskill stopped being a notebook full of scratch code and became an actual lib.
+
+- **`SkillControl`** — discovers skills under a `skills/` dir, loads a skill's `SKILL.md` (frontmatter → `Skill`, body returned to you), and reads any `references/`, `scripts/`, or `assets/` file a skill points to. Caches what it loads so you're not re-walking the filesystem every call.
+- **`ToolControl`** — turns a skill's `scripts/*.py` into a callable `Tool` schema by reading its `get_args()` (yep, plain `argparse`). Composes with `SkillControl` instead of re-solving "where's this skill" itself. Caches too.
+- **`Skill` / `Tool` / `Arg`** — the dataclasses everything above hands you back. Fields carry their own `description` in `metadata`, so the schema is self-documenting.
+- **`processing.path`** — `find_root()` (walk up 'til you hit a `skills/` folder, git-style) and `strip_path()` (clean up glob-y path fragments).
+- Real error handling everywhere that matters — no bare `raise`, no silent `IndexError`s. Every failure mode tells you what to do next.
+- Full test suite (`tests/`) covering all of the above.
+- Two runnable examples: [`examples/case1.py`](examples/case1.py) (SkillControl) and [`examples/case2.py`](examples/case2.py) (ToolControl).
+
+See [README.md](README.md) for the how/why.

broskill-0.1.0/examples/case1.py

@@ -0,0 +1,26 @@
+"""SkillControl 101 — discover, load, and read a skill's parts.
+
+Run from anywhere in the project:
+    uv run python examples/case1.py
+"""
+import sys
+
+from broskill.processing.path import find_root
+from broskill.processing.skill import SkillControl
+
+sys.stdout.reconfigure(encoding="utf-8")
+
+root = find_root()
+sc = SkillControl(root=root / "skills")
+
+print("skills we've got:")
+for skill in sc.list_skills():
+    print(f"  - {skill.name}: {skill.description}")
+
+body = sc.load_skill("read-file")
+print("\nread-file's SKILL.md body:\n")
+print(body)
+
+script = sc.load_skill_extension("read-file", "scripts/read_file.py")
+print("\nread-file's read_file.py:\n")
+print(script)

broskill-0.1.0/examples/case2.py

@@ -0,0 +1,30 @@
+"""ToolControl 101 — turn a skill's script into a callable tool schema, then run it.
+
+Run from anywhere in the project:
+    uv run python examples/case2.py
+"""
+import subprocess
+import sys
+
+from broskill.processing.path import find_root
+from broskill.processing.skill import SkillControl
+from broskill.processing.tool import ToolControl, to_args
+
+root = find_root()
+sc = SkillControl(root=root / "skills")
+sc.load_skill("read-file")
+
+tc = ToolControl(sc)
+tool = tc.load_tool("read-file", "scripts/list_files.py")
+
+print(f"tool: {tool.name}")
+print(f"description: {tool.description}")
+for arg in tool.args:
+    print(f"  - {arg.name} ({arg.type}, required={arg.required}): {arg.description}")
+
+result = subprocess.run(
+    [sys.executable, str(tool.path), *to_args({"path": "skills/**/*.md"})],
+    capture_output=True, text=True, cwd=root,
+)
+print("\noutput:\n")
+print(result.stdout)