py-okf 0.1.0__tar.gz

py_okf-0.1.0/LICENSE

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

py_okf-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: py-okf
+Version: 0.1.0
+Summary: Python library for Open Knowledge Format (OKF) file generation and refresh
+Author-email: Prabhay Gupta <coolprabhay90@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/prabhay759/py-okf
+Project-URL: Repository, https://github.com/prabhay759/py-okf
+Project-URL: Issues, https://github.com/prabhay759/py-okf/issues
+Keywords: okf,documentation,ast,code-analysis,open-knowledge-format
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == "watch"
+Dynamic: license-file
+
+# py-okf
+
+A Python library for generating and managing [Open Knowledge Format (OKF)](https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing) files from Python projects.
+
+OKF is a vendor-neutral markdown specification that lets AI agents and humans access curated knowledge without vendor lock-in — a directory of `.md` files with YAML frontmatter, one file per concept (module, class, API, dataset, etc.).
+
+`py-okf` analyzes your Python codebase using the `ast` module and generates an `.okf/` bundle of markdown files describing your project's concepts.
+
+## Installation
+
+```bash
+pip install py-okf
+```
+
+## CLI Usage
+
+```bash
+# Generate OKF files for a Python project
+okf generate /path/to/your/project
+
+# Refresh stale OKF files (only regenerates files where source changed)
+okf refresh /path/to/your/project
+
+# Validate OKF files against the spec
+okf validate /path/to/your/project
+
+# Custom output directory
+okf generate /path/to/your/project -o docs/okf
+
+# Include private (underscore-prefixed) symbols
+okf generate /path/to/your/project --include-private
+```
+
+## Python API
+
+```python
+from pyokf import analyze_project, generate_module_concepts, OKFBundle
+from pathlib import Path
+
+# Analyze a project
+modules = analyze_project(Path("./myproject"))
+
+# Generate OKF concepts
+bundle = OKFBundle(Path("./.okf"))
+bundle.ensure_directory()
+for module in modules:
+    concepts = generate_module_concepts(module)
+    bundle.write_all(concepts)
+
+# Load and validate an existing bundle
+bundle = OKFBundle(Path("./.okf")).load()
+errors = bundle.validate_directory()
+```
+
+## Generated Output
+
+Running `okf generate .` produces an `.okf/` directory with flat, dotted-name files:
+
+```
+.okf/
+├── mypackage.md                    # module concept
+├── mypackage.Connection.md         # class concept
+└── mypackage.query.md              # api concept (exported function)
+```
+
+Each file contains YAML frontmatter followed by a markdown description:
+
+```markdown
+---
+type: api
+title: mypackage.query
+description: Execute a SQL query against the active connection.
+resource: ./mypackage/__init__.py
+tags:
+- python
+- api
+timestamp: '2026-06-22T10:00:00Z'
+---
+
+# query
+
+Execute a SQL query against the active connection.
+
+## Signature
+
+    def query(sql: str, params: Optional[list[str]] = None) -> list[dict]
+
+## Parameters
+
+- **`sql`**: `str`
+- **`params`**: `Optional[list[str]]` *(default: `None`)*
+
+## Returns
+
+`list[dict]`
+```
+
+## Concept Types
+
+| Type | Description |
+|------|-------------|
+| `module` | A Python module file |
+| `class` | A class definition |
+| `function` | A top-level function |
+| `api` | A function listed in `__all__` (publicly exported) |
+
+## Requirements
+
+- Python 3.10+
+- PyYAML >= 6.0

py_okf-0.1.0/README.md

@@ -0,0 +1,110 @@
+# py-okf
+
+A Python library for generating and managing [Open Knowledge Format (OKF)](https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing) files from Python projects.
+
+OKF is a vendor-neutral markdown specification that lets AI agents and humans access curated knowledge without vendor lock-in — a directory of `.md` files with YAML frontmatter, one file per concept (module, class, API, dataset, etc.).
+
+`py-okf` analyzes your Python codebase using the `ast` module and generates an `.okf/` bundle of markdown files describing your project's concepts.
+
+## Installation
+
+```bash
+pip install py-okf
+```
+
+## CLI Usage
+
+```bash
+# Generate OKF files for a Python project
+okf generate /path/to/your/project
+
+# Refresh stale OKF files (only regenerates files where source changed)
+okf refresh /path/to/your/project
+
+# Validate OKF files against the spec
+okf validate /path/to/your/project
+
+# Custom output directory
+okf generate /path/to/your/project -o docs/okf
+
+# Include private (underscore-prefixed) symbols
+okf generate /path/to/your/project --include-private
+```
+
+## Python API
+
+```python
+from pyokf import analyze_project, generate_module_concepts, OKFBundle
+from pathlib import Path
+
+# Analyze a project
+modules = analyze_project(Path("./myproject"))
+
+# Generate OKF concepts
+bundle = OKFBundle(Path("./.okf"))
+bundle.ensure_directory()
+for module in modules:
+    concepts = generate_module_concepts(module)
+    bundle.write_all(concepts)
+
+# Load and validate an existing bundle
+bundle = OKFBundle(Path("./.okf")).load()
+errors = bundle.validate_directory()
+```
+
+## Generated Output
+
+Running `okf generate .` produces an `.okf/` directory with flat, dotted-name files:
+
+```
+.okf/
+├── mypackage.md                    # module concept
+├── mypackage.Connection.md         # class concept
+└── mypackage.query.md              # api concept (exported function)
+```
+
+Each file contains YAML frontmatter followed by a markdown description:
+
+```markdown
+---
+type: api
+title: mypackage.query
+description: Execute a SQL query against the active connection.
+resource: ./mypackage/__init__.py
+tags:
+- python
+- api
+timestamp: '2026-06-22T10:00:00Z'
+---
+
+# query
+
+Execute a SQL query against the active connection.
+
+## Signature
+
+    def query(sql: str, params: Optional[list[str]] = None) -> list[dict]
+
+## Parameters
+
+- **`sql`**: `str`
+- **`params`**: `Optional[list[str]]` *(default: `None`)*
+
+## Returns
+
+`list[dict]`
+```
+
+## Concept Types
+
+| Type | Description |
+|------|-------------|
+| `module` | A Python module file |
+| `class` | A class definition |
+| `function` | A top-level function |
+| `api` | A function listed in `__all__` (publicly exported) |
+
+## Requirements
+
+- Python 3.10+
+- PyYAML >= 6.0

py_okf-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-okf"
+version = "0.1.0"
+description = "Python library for Open Knowledge Format (OKF) file generation and refresh"
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Prabhay Gupta", email = "coolprabhay90@gmail.com"},
+]
+keywords = ["okf", "documentation", "ast", "code-analysis", "open-knowledge-format"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "PyYAML>=6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/prabhay759/py-okf"
+Repository = "https://github.com/prabhay759/py-okf"
+Issues = "https://github.com/prabhay759/py-okf/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "build>=1.0",
+    "twine>=5.0",
+]
+watch = [
+    "watchdog>=3.0",
+]
+
+[project.scripts]
+okf = "pyokf.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.coverage.run]
+source = ["src/pyokf"]
+branch = true

py_okf-0.1.0/setup.cfg

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

py_okf-0.1.0/src/py_okf.egg-info/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: py-okf
+Version: 0.1.0
+Summary: Python library for Open Knowledge Format (OKF) file generation and refresh
+Author-email: Prabhay Gupta <coolprabhay90@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/prabhay759/py-okf
+Project-URL: Repository, https://github.com/prabhay759/py-okf
+Project-URL: Issues, https://github.com/prabhay759/py-okf/issues
+Keywords: okf,documentation,ast,code-analysis,open-knowledge-format
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == "watch"
+Dynamic: license-file
+
+# py-okf
+
+A Python library for generating and managing [Open Knowledge Format (OKF)](https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing) files from Python projects.
+
+OKF is a vendor-neutral markdown specification that lets AI agents and humans access curated knowledge without vendor lock-in — a directory of `.md` files with YAML frontmatter, one file per concept (module, class, API, dataset, etc.).
+
+`py-okf` analyzes your Python codebase using the `ast` module and generates an `.okf/` bundle of markdown files describing your project's concepts.
+
+## Installation
+
+```bash
+pip install py-okf
+```
+
+## CLI Usage
+
+```bash
+# Generate OKF files for a Python project
+okf generate /path/to/your/project
+
+# Refresh stale OKF files (only regenerates files where source changed)
+okf refresh /path/to/your/project
+
+# Validate OKF files against the spec
+okf validate /path/to/your/project
+
+# Custom output directory
+okf generate /path/to/your/project -o docs/okf
+
+# Include private (underscore-prefixed) symbols
+okf generate /path/to/your/project --include-private
+```
+
+## Python API
+
+```python
+from pyokf import analyze_project, generate_module_concepts, OKFBundle
+from pathlib import Path
+
+# Analyze a project
+modules = analyze_project(Path("./myproject"))
+
+# Generate OKF concepts
+bundle = OKFBundle(Path("./.okf"))
+bundle.ensure_directory()
+for module in modules:
+    concepts = generate_module_concepts(module)
+    bundle.write_all(concepts)
+
+# Load and validate an existing bundle
+bundle = OKFBundle(Path("./.okf")).load()
+errors = bundle.validate_directory()
+```
+
+## Generated Output
+
+Running `okf generate .` produces an `.okf/` directory with flat, dotted-name files:
+
+```
+.okf/
+├── mypackage.md                    # module concept
+├── mypackage.Connection.md         # class concept
+└── mypackage.query.md              # api concept (exported function)
+```
+
+Each file contains YAML frontmatter followed by a markdown description:
+
+```markdown
+---
+type: api
+title: mypackage.query
+description: Execute a SQL query against the active connection.
+resource: ./mypackage/__init__.py
+tags:
+- python
+- api
+timestamp: '2026-06-22T10:00:00Z'
+---
+
+# query
+
+Execute a SQL query against the active connection.
+
+## Signature
+
+    def query(sql: str, params: Optional[list[str]] = None) -> list[dict]
+
+## Parameters
+
+- **`sql`**: `str`
+- **`params`**: `Optional[list[str]]` *(default: `None`)*
+
+## Returns
+
+`list[dict]`
+```
+
+## Concept Types
+
+| Type | Description |
+|------|-------------|
+| `module` | A Python module file |
+| `class` | A class definition |
+| `function` | A top-level function |
+| `api` | A function listed in `__all__` (publicly exported) |
+
+## Requirements
+
+- Python 3.10+
+- PyYAML >= 6.0

py_okf-0.1.0/src/py_okf.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+src/py_okf.egg-info/PKG-INFO
+src/py_okf.egg-info/SOURCES.txt
+src/py_okf.egg-info/dependency_links.txt
+src/py_okf.egg-info/entry_points.txt
+src/py_okf.egg-info/requires.txt
+src/py_okf.egg-info/top_level.txt
+src/pyokf/__init__.py
+src/pyokf/analyzer.py
+src/pyokf/bundle.py
+src/pyokf/cli.py
+src/pyokf/generator.py
+src/pyokf/models.py
+tests/test_analyzer.py
+tests/test_bundle.py
+tests/test_cli.py
+tests/test_generator.py
+tests/test_models.py

py_okf-0.1.0/src/py_okf.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_okf-0.1.0/src/py_okf.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+okf = pyokf.cli:main

py_okf-0.1.0/src/py_okf.egg-info/requires.txt

@@ -0,0 +1,10 @@
+PyYAML>=6.0
+
+[dev]
+pytest>=7.0
+pytest-cov>=4.0
+build>=1.0
+twine>=5.0
+
+[watch]
+watchdog>=3.0

py_okf-0.1.0/src/py_okf.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyokf

py_okf-0.1.0/src/pyokf/__init__.py

@@ -0,0 +1,33 @@
+"""py-okf: Python library for Open Knowledge Format (OKF) file generation."""
+
+__version__ = "0.1.0"
+
+from pyokf.models import (
+    ConceptType,
+    OKFConcept,
+    ArgumentInfo,
+    AttributeInfo,
+    MethodInfo,
+    ClassInfo,
+    FunctionInfo,
+    ModuleInfo,
+)
+from pyokf.analyzer import analyze_file, analyze_project
+from pyokf.generator import generate_concept, generate_module_concepts
+from pyokf.bundle import OKFBundle
+
+__all__ = [
+    "ConceptType",
+    "OKFConcept",
+    "ArgumentInfo",
+    "AttributeInfo",
+    "MethodInfo",
+    "ClassInfo",
+    "FunctionInfo",
+    "ModuleInfo",
+    "analyze_file",
+    "analyze_project",
+    "generate_concept",
+    "generate_module_concepts",
+    "OKFBundle",
+]