shalya 0.0.1__tar.gz

shalya-0.0.1/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+.venv/
+_docs/
+_proc/
+.ipynb_checkpoints/
+dist/
+build/
+*.egg-info/
+.pytest_cache/

shalya-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

shalya-0.0.1/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.5
+Name: shalya
+Version: 0.0.1
+Summary: the tools an agent is given, and the host that answers them
+Project-URL: Repository, https://github.com/vedicreader/shalya
+Project-URL: Documentation, https://vedicreader.github.io/shalya/
+Author-email: Karthik <karthik.rajgopal@hotmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: nbdev
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Requires-Dist: dhrishti
+Requires-Dist: exhash>=0.4.9
+Requires-Dist: fastcore>=2.1.16
+Requires-Dist: fastspec
+Requires-Dist: gheasy
+Requires-Dist: jupyter-client
+Requires-Dist: vishalakshi
+Provides-Extra: dev
+Requires-Dist: nbdev>=3.3.11; extra == 'dev'
+Requires-Dist: notebook>=7.6.1; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# shalya
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+A host is an object that answers what it can: read a file, search an index, run a command, remember a page. [`tools_for`](https://vedicreader.github.io/shalya/tools.html#tools_for) asks one what it supports and hands back those tools as plain functions, each with the type hints and docstring a model reads. Nothing here runs an agent loop or talks to a model.
+
+## Install
+
+``` sh
+pip install shalya
+```
+
+``` python
+from shalya.core import failed
+from shalya.host import LocalHost
+from shalya.tools import tools_for, read_only
+from shalya.skills import Skill, Registry, skill_index
+```
+
+## A host
+
+[`LocalHost`](https://vedicreader.github.io/shalya/host.html#localhost) touches only the folders you open, and reports the capability groups it can serve. A group with no installed backend goes absent rather than broken.
+
+``` python
+import shutil
+from pathlib import Path
+
+d = Path('/tmp/shalya-demo')
+shutil.rmtree(d, ignore_errors=True); d.mkdir(parents=True)
+(d/'greet.py').write_text('def hi(n): return f"hi {n}"\n')
+
+host = LocalHost(roots=[d], index=False, web=False)
+host.can('file'), host.can('memory'), sorted(host.without)
+```
+
+    (True, False, ['api', 'ask', 'memory', 'watch', 'web'])
+
+## The tools
+
+[`tools_for`](https://vedicreader.github.io/shalya/tools.html#tools_for) returns one flat list, built from the groups this host answers. Every tool takes and returns strings: a harness can pass them to a model without knowing what a host is.
+
+``` python
+ts = {t.__name__: t for t in tools_for(host)}
+len(ts), sorted(ts)
+```
+
+    (25,
+     ['add_cell',
+      'add_root',
+      'create_file',
+      'edit_cell',
+      'edit_file',
+      'git_checkout',
+      'git_divergence',
+      'git_rebase_preview',
+      'git_remote',
+      'git_status',
+      'grep',
+      'inspect_python',
+      'list_files',
+      'list_vars',
+      'ls',
+      'notebook_cells',
+      'outline',
+      'read_terminal',
+      'replace_text',
+      'run_python',
+      'run_shell',
+      'search_code',
+      'similar_code',
+      'view_cell',
+      'view_file'])
+
+A tool answers with the text a model reads. `view_file` numbers and hashes each line, and that hash is the address `edit_file` takes.
+
+``` python
+print(ts['view_file']('greet.py'))
+```
+
+    1|f8c6|def hi(n): return f"hi {n}"
+
+``` python
+print(ts['replace_text']('greet.py', '[{"oldText": "hi {n}", "newText": "hey {n}"}]'))
+```
+
+    replaced 1 block(s) in /private/tmp/shalya-demo/greet.py
+    --- a//private/tmp/shalya-demo/greet.py
+    +++ b//private/tmp/shalya-demo/greet.py
+    @@ -1 +1 @@
+    -def hi(n): return f"hi {n}"
+    +def hi(n): return f"hey {n}"
+
+A refusal is a string beginning `ERROR:`, and [`failed`](https://vedicreader.github.io/shalya/core.html#failed) is the one place that knows that spelling.
+
+``` python
+r = ts['view_file']('missing.py')
+failed(r), r
+```
+
+    (True, 'ERROR: no such file: /private/tmp/shalya-demo/missing.py')
+
+## Tools for a sub-agent
+
+[`read_only`](https://vedicreader.github.io/shalya/tools.html#read_only) filters a list for a sub-agent that must not change anything. It drops every write tool, unless that tool publishes a read-only twin. `read_url` publishes one, and the twin reads a page without saving it to memory.
+
+``` python
+sorted(set(ts) - {t.__name__ for t in read_only(ts.values())})
+```
+
+    ['add_cell',
+     'add_root',
+     'create_file',
+     'edit_cell',
+     'edit_file',
+     'git_checkout',
+     'git_remote',
+     'replace_text',
+     'run_python',
+     'run_shell']
+
+## Skills
+
+[`skill_index`](https://vedicreader.github.io/shalya/skills.html#skill_index) renders the block that goes in the system prompt: names and clipped descriptions, never bodies. [`discover`](https://vedicreader.github.io/shalya/skills.html#discover) collects installed pyskills and every `SKILL.md` under the open folders.
+
+``` python
+ks = [Skill(name='exhash', source='md', description='Hash-verified text editing.', where='', _text='View, then edit by address.'),
+      Skill(name='ghapi', source='md', description='GitHub REST access through `GhApi`.', where='', _text='Issues, pull requests, releases.')]
+print(skill_index(ks))
+```
+
+
+
+    ## Skills
+
+    Know-how available to you. Read one with `read_skill(name)` when its description matches what you are about to do, *before* you do it -- several of these describe tools already installed in this environment, so the code they discuss is also searchable with `search_code`.
+
+    - `exhash` -- Hash-verified text editing.
+    - `ghapi` -- GitHub REST access through `GhApi`.
+
+## Extensions
+
+A Python file with `setup(reg)` may add tools, skills, lifecycle hooks and an approval policy. An unknown event name raises rather than hooking nothing.
+
+``` python
+reg = Registry()
+
+@reg.tool
+def weather(city: str) -> str:
+    "Today's weather in `city`."
+    return f'sunny in {city}'
+
+reg.skill('house-style', 'Short sentences. No headings.')
+[t.__name__ for t in reg.tools], [s.name for s in reg.skills]
+```
+
+    (['weather'], ['house-style'])
+
+## Develop
+
+``` sh
+uv sync --all-extras --group dev
+uv run nbdev-export
+uv run nbdev-test
+uv run pytest
+uv run nbdev-clean
+```

shalya-0.0.1/README.md

@@ -0,0 +1,167 @@
+# shalya
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+A host is an object that answers what it can: read a file, search an index, run a command, remember a page. [`tools_for`](https://vedicreader.github.io/shalya/tools.html#tools_for) asks one what it supports and hands back those tools as plain functions, each with the type hints and docstring a model reads. Nothing here runs an agent loop or talks to a model.
+
+## Install
+
+``` sh
+pip install shalya
+```
+
+``` python
+from shalya.core import failed
+from shalya.host import LocalHost
+from shalya.tools import tools_for, read_only
+from shalya.skills import Skill, Registry, skill_index
+```
+
+## A host
+
+[`LocalHost`](https://vedicreader.github.io/shalya/host.html#localhost) touches only the folders you open, and reports the capability groups it can serve. A group with no installed backend goes absent rather than broken.
+
+``` python
+import shutil
+from pathlib import Path
+
+d = Path('/tmp/shalya-demo')
+shutil.rmtree(d, ignore_errors=True); d.mkdir(parents=True)
+(d/'greet.py').write_text('def hi(n): return f"hi {n}"\n')
+
+host = LocalHost(roots=[d], index=False, web=False)
+host.can('file'), host.can('memory'), sorted(host.without)
+```
+
+    (True, False, ['api', 'ask', 'memory', 'watch', 'web'])
+
+## The tools
+
+[`tools_for`](https://vedicreader.github.io/shalya/tools.html#tools_for) returns one flat list, built from the groups this host answers. Every tool takes and returns strings: a harness can pass them to a model without knowing what a host is.
+
+``` python
+ts = {t.__name__: t for t in tools_for(host)}
+len(ts), sorted(ts)
+```
+
+    (25,
+     ['add_cell',
+      'add_root',
+      'create_file',
+      'edit_cell',
+      'edit_file',
+      'git_checkout',
+      'git_divergence',
+      'git_rebase_preview',
+      'git_remote',
+      'git_status',
+      'grep',
+      'inspect_python',
+      'list_files',
+      'list_vars',
+      'ls',
+      'notebook_cells',
+      'outline',
+      'read_terminal',
+      'replace_text',
+      'run_python',
+      'run_shell',
+      'search_code',
+      'similar_code',
+      'view_cell',
+      'view_file'])
+
+A tool answers with the text a model reads. `view_file` numbers and hashes each line, and that hash is the address `edit_file` takes.
+
+``` python
+print(ts['view_file']('greet.py'))
+```
+
+    1|f8c6|def hi(n): return f"hi {n}"
+
+``` python
+print(ts['replace_text']('greet.py', '[{"oldText": "hi {n}", "newText": "hey {n}"}]'))
+```
+
+    replaced 1 block(s) in /private/tmp/shalya-demo/greet.py
+    --- a//private/tmp/shalya-demo/greet.py
+    +++ b//private/tmp/shalya-demo/greet.py
+    @@ -1 +1 @@
+    -def hi(n): return f"hi {n}"
+    +def hi(n): return f"hey {n}"
+
+A refusal is a string beginning `ERROR:`, and [`failed`](https://vedicreader.github.io/shalya/core.html#failed) is the one place that knows that spelling.
+
+``` python
+r = ts['view_file']('missing.py')
+failed(r), r
+```
+
+    (True, 'ERROR: no such file: /private/tmp/shalya-demo/missing.py')
+
+## Tools for a sub-agent
+
+[`read_only`](https://vedicreader.github.io/shalya/tools.html#read_only) filters a list for a sub-agent that must not change anything. It drops every write tool, unless that tool publishes a read-only twin. `read_url` publishes one, and the twin reads a page without saving it to memory.
+
+``` python
+sorted(set(ts) - {t.__name__ for t in read_only(ts.values())})
+```
+
+    ['add_cell',
+     'add_root',
+     'create_file',
+     'edit_cell',
+     'edit_file',
+     'git_checkout',
+     'git_remote',
+     'replace_text',
+     'run_python',
+     'run_shell']
+
+## Skills
+
+[`skill_index`](https://vedicreader.github.io/shalya/skills.html#skill_index) renders the block that goes in the system prompt: names and clipped descriptions, never bodies. [`discover`](https://vedicreader.github.io/shalya/skills.html#discover) collects installed pyskills and every `SKILL.md` under the open folders.
+
+``` python
+ks = [Skill(name='exhash', source='md', description='Hash-verified text editing.', where='', _text='View, then edit by address.'),
+      Skill(name='ghapi', source='md', description='GitHub REST access through `GhApi`.', where='', _text='Issues, pull requests, releases.')]
+print(skill_index(ks))
+```
+
+
+
+    ## Skills
+
+    Know-how available to you. Read one with `read_skill(name)` when its description matches what you are about to do, *before* you do it -- several of these describe tools already installed in this environment, so the code they discuss is also searchable with `search_code`.
+
+    - `exhash` -- Hash-verified text editing.
+    - `ghapi` -- GitHub REST access through `GhApi`.
+
+## Extensions
+
+A Python file with `setup(reg)` may add tools, skills, lifecycle hooks and an approval policy. An unknown event name raises rather than hooking nothing.
+
+``` python
+reg = Registry()
+
+@reg.tool
+def weather(city: str) -> str:
+    "Today's weather in `city`."
+    return f'sunny in {city}'
+
+reg.skill('house-style', 'Short sentences. No headings.')
+[t.__name__ for t in reg.tools], [s.name for s in reg.skills]
+```
+
+    (['weather'], ['house-style'])
+
+## Develop
+
+``` sh
+uv sync --all-extras --group dev
+uv run nbdev-export
+uv run nbdev-test
+uv run pytest
+uv run nbdev-clean
+```

shalya-0.0.1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "shalya"
+dynamic = ["version"]
+description = "the tools an agent is given, and the host that answers them"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "Apache-2.0"}
+authors = [{name = "Karthik", email = "karthik.rajgopal@hotmail.com"}]
+keywords = ['nbdev']
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = ["fastcore>=2.1.16","exhash>=0.4.9","vishalakshi","fastspec","gheasy","dhrishti", "jupyter-client"]
+
+[project.optional-dependencies]
+dev = ["nbdev>=3.3.11", "notebook>=7.6.1", "pytest>=8.0.0"]
+
+[project.urls]
+Repository = "https://github.com/vedicreader/shalya"
+Documentation = "https://vedicreader.github.io/shalya/"
+
+[project.entry-points.nbdev]
+shalya = "shalya._modidx:d"
+
+[tool.nbdev]
+tst_flags = "notest"
+
+[tool.hatch.build.targets.wheel]
+packages = ["shalya"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/shalya", "/README.md", "/pyproject.toml"]
+
+[tool.hatch.version]
+path = "shalya/__init__.py"
+
+[dependency-groups]
+dev = ["shalya[dev]"]

shalya-0.0.1/shalya/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"