sherma 0.1.0__tar.gz

sherma-0.1.0/.github/workflows/pr.yml

@@ -0,0 +1,32 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - run: uv python install
+
+      - run: uv sync
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format check
+        run: uv run ruff format --check .
+
+      - name: Type check
+        run: uv run pyright
+
+      - name: Unit tests
+        run: uv run pytest -m "not integration"
+
+      - name: Integration tests
+        run: uv run pytest -m "integration" --no-header -rN || test $? -eq 5

sherma-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,78 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - run: uv python install
+
+      - run: uv sync
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format check
+        run: uv run ruff format --check .
+
+      - name: Type check
+        run: uv run pyright
+
+      - name: Unit tests
+        run: uv run pytest -m "not integration"
+
+      - name: Integration tests
+        run: uv run pytest -m "integration" --no-header -rN || test $? -eq 5
+
+  release:
+    needs: checks
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: astral-sh/setup-uv@v5
+
+      - run: uv python install
+
+      - run: uv sync
+
+      - name: Configure git for github-actions[bot]
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version
+        id: bump
+        run: |
+          if uv run cz bump --yes --changelog; then
+            echo "bumped=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "bumped=false" >> "$GITHUB_OUTPUT"
+            echo "No bumpable commits, skipping release"
+          fi
+
+      - name: Push version bump
+        if: steps.bump.outputs.bumped == 'true'
+        run: git push origin main --tags
+
+      - name: Build package
+        if: steps.bump.outputs.bumped == 'true'
+        run: uv build
+
+      - name: Publish to PyPI
+        if: steps.bump.outputs.bumped == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1

sherma-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

sherma-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.13.9
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: uv run pyright
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest
+        entry: uv run pytest -m "not integration"
+        language: system
+        types: [python]
+        pass_filenames: false

sherma-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

sherma-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+## v0.2.0 (2026-03-05)
+
+### Feat
+
+- init repo (#1)

sherma-0.1.0/CLAUDE.md

@@ -0,0 +1,48 @@
+# Project: sherma
+
+## Planning Workflow
+
+- Every task has a corresponding plan. Before implementing a task, enter plan mode and create a plan.
+- Save all plans to the `tasks/plans/` folder.
+- Plans follow the same naming convention as tasks: `<number>-<kebab-case-description>.md` (e.g., `tasks/plans/0-setup-python-repo.md` is the plan for `tasks/0-setup-python-repo.md`).
+- After the plan is saved, exit plan mode and implement the plan.
+
+## Tech Stack
+
+- **Language:** Python 3.13
+- **Package manager:** uv
+- **Build backend:** hatchling
+- **Linter/Formatter:** ruff
+- **Type checker:** pyright
+- **Testing:** pytest
+- **Commits:** commitizen (conventional commits)
+- **Git hooks:** pre-commit
+- **CI/CD:** GitHub Actions
+
+## Common Commands
+
+```bash
+uv sync                              # Install dependencies
+uv run ruff check .                  # Lint
+uv run ruff format --check .         # Format check
+uv run pyright                       # Type check
+uv run pytest                        # Run tests
+uv run pytest -m "not integration"   # Unit tests only
+uv run pytest -m "integration"       # Integration tests only
+uv run pre-commit run --all-files    # Run all pre-commit hooks
+```
+
+## Project Structure
+
+```
+sherma/
+  __init__.py       # Package init, __version__, re-exports
+  hello.py          # Hello world function
+  py.typed          # PEP 561 type marker
+tests/
+  test_hello.py     # Unit tests
+docs/
+  README.md         # Consumer documentation
+tasks/
+  plans/            # Task plans
+```

sherma-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rohith Ramakrishnan
+
+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.

sherma-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: sherma
+Version: 0.1.0
+Summary: Agent Framework rising through the citadel!
+Author: Rohith Ramakrishnan
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# sherma
+
+Agent Framework rising through the citadel!
+
+## Tech Stack
+
+| Tool | Purpose |
+|------|---------|
+| Python 3.13 | Language |
+| uv | Package manager |
+| hatchling | Build backend |
+| ruff | Linter and formatter |
+| pyright | Type checker |
+| pytest | Testing framework |
+| commitizen | Conventional commits and version bumps |
+| pre-commit | Git hook management |
+| GitHub Actions | CI/CD |
+
+## Local Development
+
+```bash
+# Clone the repo
+git clone https://github.com/MadaraUchiha-314/sherma.git
+cd sherma
+
+# Install dependencies
+uv sync
+
+# Install pre-commit hooks
+uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Running Checks
+
+```bash
+# Lint
+uv run ruff check .
+
+# Format
+uv run ruff format --check .
+
+# Type check
+uv run pyright
+
+# Unit tests
+uv run pytest
+
+# All pre-commit hooks
+uv run pre-commit run --all-files
+```
+
+## Commit Conventions
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). Commit messages must follow the format:
+
+```
+<type>(optional scope): <description>
+```
+
+Common types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`.
+
+Commitizen enforces this via a commit-msg hook and handles automatic version bumping on merge to main.

sherma-0.1.0/README.md

@@ -0,0 +1,62 @@
+# sherma
+
+Agent Framework rising through the citadel!
+
+## Tech Stack
+
+| Tool | Purpose |
+|------|---------|
+| Python 3.13 | Language |
+| uv | Package manager |
+| hatchling | Build backend |
+| ruff | Linter and formatter |
+| pyright | Type checker |
+| pytest | Testing framework |
+| commitizen | Conventional commits and version bumps |
+| pre-commit | Git hook management |
+| GitHub Actions | CI/CD |
+
+## Local Development
+
+```bash
+# Clone the repo
+git clone https://github.com/MadaraUchiha-314/sherma.git
+cd sherma
+
+# Install dependencies
+uv sync
+
+# Install pre-commit hooks
+uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Running Checks
+
+```bash
+# Lint
+uv run ruff check .
+
+# Format
+uv run ruff format --check .
+
+# Type check
+uv run pyright
+
+# Unit tests
+uv run pytest
+
+# All pre-commit hooks
+uv run pre-commit run --all-files
+```
+
+## Commit Conventions
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). Commit messages must follow the format:
+
+```
+<type>(optional scope): <description>
+```
+
+Common types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`.
+
+Commitizen enforces this via a commit-msg hook and handles automatic version bumping on merge to main.

sherma-0.1.0/docs/README.md

@@ -0,0 +1,16 @@
+# sherma
+
+## Installation
+
+```bash
+pip install sherma
+```
+
+## Quick Start
+
+```python
+from sherma import hello
+
+print(hello())         # Hello, world!
+print(hello("agent"))  # Hello, agent!
+```

sherma-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sherma"
+version = "0.1.0"
+description = "Agent Framework rising through the citadel!"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "MIT"
+authors = [{ name = "Rohith Ramakrishnan" }]
+
+[dependency-groups]
+dev = ["ruff", "pyright", "pytest", "pre-commit", "commitizen"]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "UP", "RUF"]
+
+[tool.pyright]
+typeCheckingMode = "standard"
+include = ["sherma/"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = ["integration: marks tests as integration tests"]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "0.2.0"
+tag_format = "v$version"
+version_files = ["sherma/__init__.py:__version__"]
+update_changelog_on_bump = true

sherma-0.1.0/sherma/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "0.2.0"
+
+from sherma.hello import hello
+
+__all__ = ["hello"]

sherma-0.1.0/sherma/hello.py

@@ -0,0 +1,2 @@
+def hello(name: str = "world") -> str:
+    return f"Hello, {name}!"

sherma-0.1.0/tasks/0-setup-python-repo.md

@@ -0,0 +1,33 @@
+- Python (3) is the language
+    - Use the latest version of python 3
+- Use pyproject.toml
+- Use uv as the package manager
+- Install python dependencies in current repo
+    - `.venv` folder
+- Use ruff as the linter
+- Use pyright as the type checker
+- Use pytest
+- Creates a `docs/` folder for documentation of this project
+    - These docs are primarily for consumers of this package.
+    - The developer docs will be in the README.md at the project root
+- Use the most populat commit linter for python
+    - This is to ensure that commit messages follow "sematic-commit" or "conventional-commit"
+        - basically the `fix`, `feat` ... format
+- Pre-Commit
+    - Run lint, type-checks, unit tests
+- Github Actions
+    - On PR
+        - Do the same thing as pre-commit lint
+        - Run Integration tests
+    - On merge to main
+        - Run all things that run on PR
+        - Publish package to Pypi
+            - The package name is: `sherma`
+        - Update master with the new version number of the package
+- Create a hello world function as the only function right now
+    - Create unit test for that function as an example
+- Update README.md with tech stack used in the project and local development instructions
+    - include instructions on installing the pre-commit hooks
+- All code should be under the folder `sherma`
+    - create this folder in the root of the project
+    - all imports should look like: `from sherma import ...`