codesigs 0.0.1__tar.gz

codesigs-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 [yyyy] [name of copyright owner]
+
+   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.

codesigs-0.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

codesigs-0.0.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: codesigs
+Version: 0.0.1
+Summary: Extract function and method signatures from source code across multiple languages.
+Home-page: https://github.com/AnswerDotAI/codesigs
+Author: Jeremy Howard
+Author-email: github@jhoward.fastmail.fm
+License: Apache-2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore
+Requires-Dist: ast-grep-py
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# codesigs
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## About `codesigs`
+
+`codesigs` extracts function and method signatures from source code
+across over a dozen programming languages. It uses
+[ast-grep](https://ast-grep.github.io/) for most languages and Python’s
+built-in `ast` module for Python files, providing accurate syntax-aware
+parsing rather than brittle regex matching.
+
+This is useful for:
+
+- **Documentation generation** - quickly summarize the public API of a
+  codebase
+- **Code search and navigation** - find functions by signature pattern
+- **LLM context preparation** - provide compact API summaries to
+  language models without including full implementations
+- **Codebase analysis** - understand the structure of unfamiliar
+  projects
+
+## Installation
+
+Install latest from [pypi](https://pypi.org/project/codesigs/)
+
+``` sh
+$ pip install codesigs
+```
+
+## How to use
+
+Pass source code to a language-specific function to get a list of
+signatures:
+
+``` python
+sigs = py_sigs("""
+def greet(name, age=10):
+    "Say hello to someone"
+    return f"Hello {name}, you are {age}"
+
+class Calculator:
+    def add(self, a, b):
+        return a + b
+""")
+for o in sigs: print(o)
+```
+
+    def greet(name, age=10):
+        "Say hello to someone" ...
+    class Calculator: ...
+        def add(self, a, b): ...
+
+Use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)
+when you have source code and know the file extension:
+
+``` python
+ext_sigs("function greet(name) { return `Hello ${name}`; }", ".js")
+```
+
+    ['function greet(name) {...}']
+
+Or use
+[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+to read and extract signatures from a file in one step:
+
+``` python
+file_sigs('../codesigs/core.py')[:3]
+```
+
+    ['def get_docstring(node, lines):\n    "Get docstring from source lines if present" ...',
+     'def _node_sig(node, lines): ...',
+     'def py_sigs(src):\n    "Extract class/function/method signatures from Python source" ...']
+
+The package supports Python, JavaScript/TypeScript, Java, Rust, C#, CSS,
+Go, Ruby, PHP, Kotlin, Swift, and Lua. Each language has a dedicated
+function
+(e.g. [`js_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#js_sigs),
+[`rust_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#rust_sigs)),
+or use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)/[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+which auto-detect from the extension.

codesigs-0.0.1/README.md

@@ -0,0 +1,84 @@
+# codesigs
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## About `codesigs`
+
+`codesigs` extracts function and method signatures from source code
+across over a dozen programming languages. It uses
+[ast-grep](https://ast-grep.github.io/) for most languages and Python’s
+built-in `ast` module for Python files, providing accurate syntax-aware
+parsing rather than brittle regex matching.
+
+This is useful for:
+
+- **Documentation generation** - quickly summarize the public API of a
+  codebase
+- **Code search and navigation** - find functions by signature pattern
+- **LLM context preparation** - provide compact API summaries to
+  language models without including full implementations
+- **Codebase analysis** - understand the structure of unfamiliar
+  projects
+
+## Installation
+
+Install latest from [pypi](https://pypi.org/project/codesigs/)
+
+``` sh
+$ pip install codesigs
+```
+
+## How to use
+
+Pass source code to a language-specific function to get a list of
+signatures:
+
+``` python
+sigs = py_sigs("""
+def greet(name, age=10):
+    "Say hello to someone"
+    return f"Hello {name}, you are {age}"
+
+class Calculator:
+    def add(self, a, b):
+        return a + b
+""")
+for o in sigs: print(o)
+```
+
+    def greet(name, age=10):
+        "Say hello to someone" ...
+    class Calculator: ...
+        def add(self, a, b): ...
+
+Use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)
+when you have source code and know the file extension:
+
+``` python
+ext_sigs("function greet(name) { return `Hello ${name}`; }", ".js")
+```
+
+    ['function greet(name) {...}']
+
+Or use
+[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+to read and extract signatures from a file in one step:
+
+``` python
+file_sigs('../codesigs/core.py')[:3]
+```
+
+    ['def get_docstring(node, lines):\n    "Get docstring from source lines if present" ...',
+     'def _node_sig(node, lines): ...',
+     'def py_sigs(src):\n    "Extract class/function/method signatures from Python source" ...']
+
+The package supports Python, JavaScript/TypeScript, Java, Rust, C#, CSS,
+Go, Ruby, PHP, Kotlin, Swift, and Lua. Each language has a dedicated
+function
+(e.g. [`js_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#js_sigs),
+[`rust_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#rust_sigs)),
+or use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)/[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+which auto-detect from the extension.

codesigs-0.0.1/codesigs/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.0.1"
+from .core import *

codesigs-0.0.1/codesigs/_modidx.py

@@ -0,0 +1,24 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/codesigs',
+                'doc_host': 'https://AnswerDotAI.github.io',
+                'git_url': 'https://github.com/AnswerDotAI/codesigs',
+                'lib_path': 'codesigs'},
+  'syms': { 'codesigs.core': { 'codesigs.core._get_sigs': ('core.html#_get_sigs', 'codesigs/core.py'),
+                               'codesigs.core._node_sig': ('core.html#_node_sig', 'codesigs/core.py'),
+                               'codesigs.core.csharp_sigs': ('core.html#csharp_sigs', 'codesigs/core.py'),
+                               'codesigs.core.css_selectors': ('core.html#css_selectors', 'codesigs/core.py'),
+                               'codesigs.core.ext_sigs': ('core.html#ext_sigs', 'codesigs/core.py'),
+                               'codesigs.core.file_sigs': ('core.html#file_sigs', 'codesigs/core.py'),
+                               'codesigs.core.get_docstring': ('core.html#get_docstring', 'codesigs/core.py'),
+                               'codesigs.core.go_sigs': ('core.html#go_sigs', 'codesigs/core.py'),
+                               'codesigs.core.java_sigs': ('core.html#java_sigs', 'codesigs/core.py'),
+                               'codesigs.core.js_sigs': ('core.html#js_sigs', 'codesigs/core.py'),
+                               'codesigs.core.kotlin_sigs': ('core.html#kotlin_sigs', 'codesigs/core.py'),
+                               'codesigs.core.lua_sigs': ('core.html#lua_sigs', 'codesigs/core.py'),
+                               'codesigs.core.php_sigs': ('core.html#php_sigs', 'codesigs/core.py'),
+                               'codesigs.core.py_sigs': ('core.html#py_sigs', 'codesigs/core.py'),
+                               'codesigs.core.ruby_sigs': ('core.html#ruby_sigs', 'codesigs/core.py'),
+                               'codesigs.core.rust_sigs': ('core.html#rust_sigs', 'codesigs/core.py'),
+                               'codesigs.core.swift_sigs': ('core.html#swift_sigs', 'codesigs/core.py')}}}

codesigs-0.0.1/codesigs/core.py

@@ -0,0 +1,147 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto #0
+__all__ = ['get_docstring', 'py_sigs', 'js_sigs', 'java_sigs', 'rust_sigs', 'csharp_sigs', 'css_selectors', 'go_sigs',
+           'kotlin_sigs', 'swift_sigs', 'lua_sigs', 'php_sigs', 'ruby_sigs', 'ext_sigs', 'file_sigs']
+
+# %% ../nbs/00_core.ipynb #033c76fd
+from fastcore.utils import *
+from fastcore.meta import delegates
+from ast_grep_py import SgRoot
+
+import ast
+
+# %% ../nbs/00_core.ipynb #8b98c134
+def get_docstring(node, lines):
+    "Get docstring from source lines if present"
+    if not (node.body and isinstance(node.body[0], ast.Expr) and isinstance(node.body[0].value, ast.Constant)): return None
+    doc_node = node.body[0]
+    return '\n'.join(lines[doc_node.lineno-1:doc_node.end_lineno])
+
+def _node_sig(node, lines):
+    body_start = max(node.body[0].lineno - 1, node.lineno)
+    sig = '\n'.join(lines[node.lineno-1:body_start])
+    doc = get_docstring(node, lines)
+    return (f"{sig}\n{doc}" if doc else sig).strip('\r\n') + ' ...'
+
+def py_sigs(src):
+    "Extract class/function/method signatures from Python source"
+    tree,lines = ast.parse(src),src.splitlines()
+    def _collect(nodes):
+        sigs = []
+        for n in nodes:
+            if isinstance(n, (ast.FunctionDef, ast.AsyncFunctionDef, ast.ClassDef)):
+                sigs.append(_node_sig(n, lines))
+                sigs.extend(_collect(n.body))
+        return sigs
+    return _collect(tree.body)
+
+# %% ../nbs/00_core.ipynb #5c60cc8c
+def _get_sigs(src, lang, kinds, name_kind, params_kind, fmt):
+    root = SgRoot(src, lang).root()
+    sigs = []
+    for kind in kinds:
+        for n in root.find_all(kind=kind):
+            name,params = n.find(kind=name_kind),n.find(kind=params_kind)
+            if name and params: sigs.append(fmt(n, name.text(), params.text()))
+    return sigs
+
+# %% ../nbs/00_core.ipynb #ea058abf
+def js_sigs(src, lang="javascript"):
+    "Extract function signatures from JS/TS source"
+    sigs = _get_sigs(src, lang, ["function_declaration"], "identifier", "formal_parameters",
+                     lambda n,nm,ps: f"function {nm}{ps} {{...}}")
+    sigs += _get_sigs(src, lang, ["method_definition"], "property_identifier", "formal_parameters",
+                      lambda n,nm,ps: f"{nm}{ps} {{...}}")
+    return sigs
+
+# %% ../nbs/00_core.ipynb #d175e1f3
+def java_sigs(src):
+    "Extract method signatures from Java source"
+    def fmt(n, nm, ps):
+        typ = n.find(kind="type_identifier") or n.find(kind="void_type") or n.find(kind="integral_type")
+        return f"{typ.text() if typ else 'void'} {nm}{ps};"
+    return _get_sigs(src, "java", ["method_declaration"], "identifier", "formal_parameters", fmt)
+
+# %% ../nbs/00_core.ipynb #4492b94d
+def rust_sigs(src):
+    "Extract function signatures from Rust source"
+    return _get_sigs(src, "rust", ["function_item"], "identifier", "parameters",
+                     lambda n,nm,ps: f"fn {nm}{ps} {{...}}")
+
+# %% ../nbs/00_core.ipynb #db15d753
+def csharp_sigs(src):
+    "Extract method signatures from C# source"
+    def fmt(n, nm, ps):
+        typ = n.find(kind="predefined_type") or n.find(kind="identifier")
+        return f"{typ.text() if typ else 'void'} {nm}{ps};"
+    return _get_sigs(src, "csharp", ["method_declaration"], "identifier", "parameter_list", fmt)
+
+# %% ../nbs/00_core.ipynb #62eb97fb
+def css_selectors(src):
+    "Extract CSS selectors from source"
+    root = SgRoot(src, "css").root()
+    return [f"{n.text()} {{...}}" for n in root.find_all(kind="selectors")]
+
+# %% ../nbs/00_core.ipynb #148e8adb
+def go_sigs(src):
+    "Extract function signatures from Go source"
+    root = SgRoot(src, "go").root()
+    sigs = []
+    for n in root.find_all(kind="function_declaration"):
+        name,params = n.find(kind="identifier"),n.find(kind="parameter_list")
+        if name and params: sigs.append(f"func {name.text()}{params.text()} {{...}}")
+    for n in root.find_all(kind="method_declaration"):
+        recv,name = n.find(kind="parameter_list"),n.find(kind="field_identifier")
+        params = n.find_all(kind="parameter_list")
+        if name and len(params) > 1: sigs.append(f"func {recv.text()} {name.text()}{params[1].text()} {{...}}")
+    return sigs
+
+# %% ../nbs/00_core.ipynb #ac7ea6f5
+def kotlin_sigs(src):
+    "Extract function signatures from Kotlin source"
+    return _get_sigs(src, "kotlin", ["function_declaration"], "simple_identifier", "function_value_parameters",
+                     lambda n,nm,ps: f"fun {nm}{ps} {{...}}")
+
+# %% ../nbs/00_core.ipynb #a6ee3031
+def swift_sigs(src):
+    "Extract function signatures from Swift source"
+    return _get_sigs(src, "swift", ["function_declaration"], "simple_identifier", "parameter",
+                     lambda n,nm,ps: f"func {nm}({ps}) {{...}}")
+
+# %% ../nbs/00_core.ipynb #726f9ab9
+def lua_sigs(src):
+    "Extract function signatures from Lua source"
+    return _get_sigs(src, "lua", ["function_declaration"], "identifier", "parameters",
+                     lambda n,nm,ps: f"function {nm}{ps} ... end")
+
+# %% ../nbs/00_core.ipynb #94cad5be
+def php_sigs(src):
+    "Extract function signatures from PHP source"
+    return _get_sigs(src, "php", ["function_definition", "method_declaration"], "name", "formal_parameters",
+                     lambda n,nm,ps: f"function {nm}{ps} {{...}}")
+
+# %% ../nbs/00_core.ipynb #11cdf226
+def ruby_sigs(src):
+    "Extract method signatures from Ruby source"
+    return _get_sigs(src, "ruby", ["method"], "identifier", "method_parameters",
+                     lambda n,nm,ps: f"def {nm}{ps} ... end")
+
+# %% ../nbs/00_core.ipynb #f58e9a0e
+_sigs_fns = {'.py': py_sigs, '.js': js_sigs, '.ts': lambda s: js_sigs(s, "typescript"), '.jsx': js_sigs, 
+             '.tsx': lambda s: js_sigs(s, "typescript"), '.java': java_sigs, '.rs': rust_sigs, 
+             '.cs': csharp_sigs, '.css': css_selectors, '.go': go_sigs, '.rb': ruby_sigs,
+             '.php': php_sigs, '.kt': kotlin_sigs, '.kts': kotlin_sigs, '.swift': swift_sigs, '.lua': lua_sigs}
+
+# %% ../nbs/00_core.ipynb #6244c5c8
+def ext_sigs(src, ext):
+    "Read retrieve signatures for `src` based on suitable langage for `ext`"
+    if not ext.startswith('.'): ext = '.'+ext
+    fn = _sigs_fns.get(ext)
+    return [] if fn is None else fn(src)
+
+# %% ../nbs/00_core.ipynb #69100796
+def file_sigs(fname):
+    "Read file content and retrieve signatures"
+    fname = Path(fname).expanduser()
+    return ext_sigs(fname.read_text(), fname.suffix)

codesigs-0.0.1/codesigs.egg-info/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: codesigs
+Version: 0.0.1
+Summary: Extract function and method signatures from source code across multiple languages.
+Home-page: https://github.com/AnswerDotAI/codesigs
+Author: Jeremy Howard
+Author-email: github@jhoward.fastmail.fm
+License: Apache-2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore
+Requires-Dist: ast-grep-py
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# codesigs
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## About `codesigs`
+
+`codesigs` extracts function and method signatures from source code
+across over a dozen programming languages. It uses
+[ast-grep](https://ast-grep.github.io/) for most languages and Python’s
+built-in `ast` module for Python files, providing accurate syntax-aware
+parsing rather than brittle regex matching.
+
+This is useful for:
+
+- **Documentation generation** - quickly summarize the public API of a
+  codebase
+- **Code search and navigation** - find functions by signature pattern
+- **LLM context preparation** - provide compact API summaries to
+  language models without including full implementations
+- **Codebase analysis** - understand the structure of unfamiliar
+  projects
+
+## Installation
+
+Install latest from [pypi](https://pypi.org/project/codesigs/)
+
+``` sh
+$ pip install codesigs
+```
+
+## How to use
+
+Pass source code to a language-specific function to get a list of
+signatures:
+
+``` python
+sigs = py_sigs("""
+def greet(name, age=10):
+    "Say hello to someone"
+    return f"Hello {name}, you are {age}"
+
+class Calculator:
+    def add(self, a, b):
+        return a + b
+""")
+for o in sigs: print(o)
+```
+
+    def greet(name, age=10):
+        "Say hello to someone" ...
+    class Calculator: ...
+        def add(self, a, b): ...
+
+Use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)
+when you have source code and know the file extension:
+
+``` python
+ext_sigs("function greet(name) { return `Hello ${name}`; }", ".js")
+```
+
+    ['function greet(name) {...}']
+
+Or use
+[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+to read and extract signatures from a file in one step:
+
+``` python
+file_sigs('../codesigs/core.py')[:3]
+```
+
+    ['def get_docstring(node, lines):\n    "Get docstring from source lines if present" ...',
+     'def _node_sig(node, lines): ...',
+     'def py_sigs(src):\n    "Extract class/function/method signatures from Python source" ...']
+
+The package supports Python, JavaScript/TypeScript, Java, Rust, C#, CSS,
+Go, Ruby, PHP, Kotlin, Swift, and Lua. Each language has a dedicated
+function
+(e.g. [`js_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#js_sigs),
+[`rust_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#rust_sigs)),
+or use
+[`ext_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#ext_sigs)/[`file_sigs`](https://AnswerDotAI.github.io/codesigs/core.html#file_sigs)
+which auto-detect from the extension.

codesigs-0.0.1/codesigs.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+settings.ini
+setup.py
+codesigs/__init__.py
+codesigs/_modidx.py
+codesigs/core.py
+codesigs.egg-info/PKG-INFO
+codesigs.egg-info/SOURCES.txt
+codesigs.egg-info/dependency_links.txt
+codesigs.egg-info/entry_points.txt
+codesigs.egg-info/not-zip-safe
+codesigs.egg-info/requires.txt
+codesigs.egg-info/top_level.txt

codesigs-0.0.1/codesigs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

codesigs-0.0.1/codesigs.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[nbdev]
+codesigs = codesigs._modidx:d

codesigs-0.0.1/codesigs.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

codesigs-0.0.1/codesigs.egg-info/requires.txt

@@ -0,0 +1,4 @@
+fastcore
+ast-grep-py
+
+[dev]

codesigs-0.0.1/codesigs.egg-info/top_level.txt

@@ -0,0 +1 @@
+codesigs

codesigs-0.0.1/pyproject.toml

@@ -0,0 +1,11 @@
+[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name="codesigs"
+requires-python=">=3.9"
+dynamic = [ "keywords", "description", "version", "dependencies", "optional-dependencies", "readme", "license", "authors", "classifiers", "entry-points", "scripts", "urls"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "settings.ini" }, { file = "setup.py" }]

codesigs-0.0.1/settings.ini

@@ -0,0 +1,46 @@
+[DEFAULT]
+# All sections below are required unless otherwise specified.
+# See https://github.com/AnswerDotAI/nbdev/blob/main/settings.ini for examples.
+
+### Python library ###
+repo = codesigs
+lib_name = %(repo)s
+version = 0.0.1
+min_python = 3.9
+license = apache2
+black_formatting = False
+requirements = fastcore ast-grep-py
+
+### nbdev ###
+doc_path = _docs
+lib_path = codesigs
+nbs_path = nbs
+recursive = True
+tst_flags = notest
+put_version_in_init = True
+update_pyproject = True
+
+### Docs ###
+branch = main
+custom_sidebar = False
+doc_host = https://%(user)s.github.io
+doc_baseurl = /%(repo)s
+git_url = https://github.com/%(user)s/%(repo)s
+title = %(lib_name)s
+
+### PyPI ###
+audience = Developers
+author = Jeremy Howard
+author_email = github@jhoward.fastmail.fm
+copyright = 2026 onwards, %(author)s
+description = Extract function and method signatures from source code across multiple languages.
+keywords = nbdev jupyter notebook python
+language = English
+status = 3
+user = AnswerDotAI
+
+### Optional ###
+# dev_requirements = 
+# console_scripts =
+# conda_user = 
+# package_data =

codesigs-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

codesigs-0.0.1/setup.py

@@ -0,0 +1,63 @@
+from pkg_resources import parse_version
+from configparser import ConfigParser
+import setuptools, shlex
+assert parse_version(setuptools.__version__)>=parse_version('36.2')
+
+# note: all settings are in settings.ini; edit there, not here
+config = ConfigParser(delimiters=['='])
+config.read('settings.ini', encoding='utf-8')
+cfg = config['DEFAULT']
+
+cfg_keys = 'version description keywords author author_email'.split()
+expected = cfg_keys + "lib_name user branch license status min_python audience language".split()
+for o in expected: assert o in cfg, "missing expected setting: {}".format(o)
+setup_cfg = {o:cfg[o] for o in cfg_keys}
+
+licenses = {
+    'apache2': 'Apache-2.0',
+    'mit': 'MIT',
+    'gpl2': 'GPL-2.0-only',
+    'gpl3': 'GPL-3.0-or-later',
+    'bsd3': 'BSD-3-Clause',
+}
+statuses = [ '1 - Planning', '2 - Pre-Alpha', '3 - Alpha',
+    '4 - Beta', '5 - Production/Stable', '6 - Mature', '7 - Inactive' ]
+py_versions = '3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13'.split()
+
+requirements = shlex.split(cfg.get('requirements', ''))
+if cfg.get('pip_requirements'): requirements += shlex.split(cfg.get('pip_requirements', ''))
+min_python = cfg['min_python']
+dev_requirements = (cfg.get('dev_requirements') or '').split()
+
+package_data = dict()
+pkg_data = cfg.get('package_data', None)
+if pkg_data:
+    package_data[cfg['lib_name']] =  pkg_data.split() # split as multiple files might be listed
+# Add package data to setup_cfg for setuptools.setup(..., **setup_cfg)
+setup_cfg['package_data'] = package_data
+
+setuptools.setup(
+    name = cfg['lib_name'],
+    license = licenses.get(cfg['license'].lower(), cfg['license']),
+    classifiers = [
+        'Development Status :: ' + statuses[int(cfg['status'])],
+        'Intended Audience :: ' + cfg['audience'].title(),
+        'Natural Language :: ' + cfg['language'].title(),
+    ] + ['Programming Language :: Python :: '+o for o in py_versions[py_versions.index(min_python):]],
+    url = cfg['git_url'],
+    packages = setuptools.find_packages(),
+    include_package_data = True,
+    install_requires = requirements,
+    extras_require={ 'dev': dev_requirements },
+    dependency_links = cfg.get('dep_links','').split(),
+    python_requires  = '>=' + cfg['min_python'],
+    long_description = open('README.md', encoding='utf-8').read(),
+    long_description_content_type = 'text/markdown',
+    zip_safe = False,
+    entry_points = {
+        'console_scripts': cfg.get('console_scripts','').split(),
+        'nbdev': [f'{cfg.get("lib_path")}={cfg.get("lib_path")}._modidx:d']
+    },
+    **setup_cfg)
+
+