code2logic 1.0.13__tar.gz

code2logic-1.0.13/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.

code2logic-1.0.13/PKG-INFO

@@ -0,0 +1,470 @@
+Metadata-Version: 2.3
+Name: code2logic
+Version: 1.0.13
+Summary: Convert source code to logical representation for LLM analysis
+License: Apache-2.0
+Keywords: code-analysis,llm,ast,static-analysis,tree-sitter,code-understanding,documentation,dependency-graph,nlp
+Author: Softreck
+Author-email: info@softreck.dev
+Maintainer: Softreck
+Maintainer-email: info@softreck.dev
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Provides-Extra: full
+Provides-Extra: graph
+Provides-Extra: llm
+Provides-Extra: nlp
+Provides-Extra: similarity
+Provides-Extra: treesitter
+Requires-Dist: httpx (>=0.25.0) ; extra == "llm"
+Requires-Dist: litellm (>=1.0.0) ; extra == "llm"
+Requires-Dist: networkx (>=3.0) ; extra == "graph" or extra == "full"
+Requires-Dist: nltk (>=3.8) ; extra == "nlp" or extra == "full"
+Requires-Dist: pyyaml (>=6.0) ; extra == "full"
+Requires-Dist: rapidfuzz (>=3.0) ; extra == "similarity" or extra == "full"
+Requires-Dist: tree-sitter (>=0.21.0) ; extra == "treesitter" or extra == "full"
+Requires-Dist: tree-sitter-javascript (>=0.21.0) ; extra == "treesitter" or extra == "full"
+Requires-Dist: tree-sitter-python (>=0.21.0) ; extra == "treesitter" or extra == "full"
+Requires-Dist: tree-sitter-typescript (>=0.21.0) ; extra == "treesitter" or extra == "full"
+Project-URL: Changelog, https://github.com/wronai/code2logic/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://code2logic.readthedocs.io
+Project-URL: Homepage, https://github.com/wronai/code2logic
+Project-URL: Issues, https://github.com/wronai/code2logic/issues
+Project-URL: Repository, https://github.com/wronai/code2logic.git
+Description-Content-Type: text/markdown
+
+# Code2Logic
+
+[![PyPI version](https://badge.fury.io/py/code2logic.svg)](https://badge.fury.io/py/code2logic)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+**Convert source code to logical representation for LLM analysis.**
+
+Code2Logic analyzes codebases and generates compact, LLM-friendly representations with semantic understanding.
+Perfect for feeding project context to AI assistants, building code documentation, or analyzing code structure.
+
+## ✨ Features
+
+- 🌳 **Multi-language support** - Python, JavaScript, TypeScript, Java, Go, Rust, and more
+- 🎯 **Tree-sitter AST parsing** - 99% accuracy with graceful fallback
+- 📊 **NetworkX dependency graphs** - PageRank, hub detection, cycle analysis
+- 🔍 **Rapidfuzz similarity** - Find duplicate and similar functions
+- 🧠 **NLP intent extraction** - Human-readable function descriptions
+- 📦 **Zero dependencies** - Core works without any external libs
+
+## 🚀 Installation
+
+### Basic (no dependencies)
+
+```bash
+pip install code2logic
+```
+
+### Full (all features)
+
+```bash
+pip install code2logic[full]
+```
+
+### Selective features
+
+```bash
+pip install code2logic[treesitter]  # High-accuracy AST parsing
+pip install code2logic[graph]       # Dependency analysis
+pip install code2logic[similarity]  # Similar function detection
+pip install code2logic[nlp]         # Enhanced intents
+```
+
+## 📖 Quick Start
+
+### Command Line
+
+```bash
+# Standard Markdown output
+code2logic /path/to/project
+
+# Compact YAML (14% smaller, meta.legend transparency)
+code2logic /path/to/project -f yaml --compact -o analysis-compact.yaml
+
+# Ultra-compact TOON (71% smaller, single-letter keys)
+code2logic /path/to/project -f toon --ultra-compact -o analysis-ultra.toon
+
+# Generate schema alongside output
+code2logic /path/to/project -f yaml --compact --with-schema
+
+# With detailed analysis
+code2logic /path/to/project -d detailed
+```
+
+### Python API
+
+```python
+from code2logic import analyze_project, MarkdownGenerator
+
+# Analyze a project
+project = analyze_project("/path/to/project")
+
+# Generate output
+generator = MarkdownGenerator()
+output = generator.generate(project, detail_level='standard')
+print(output)
+
+# Access analysis results
+print(f"Files: {project.total_files}")
+print(f"Lines: {project.total_lines}")
+print(f"Languages: {project.languages}")
+
+# Get hub modules (most important)
+hubs = [p for p, n in project.dependency_metrics.items() if n.is_hub]
+print(f"Key modules: {hubs}")
+```
+
+### Organized Imports
+
+```python
+# Core analysis
+from code2logic.core import ProjectInfo, ProjectAnalyzer, analyze_project
+
+# Format generators
+from code2logic.formats import (
+    YAMLGenerator, JSONGenerator, TOONGenerator,
+    LogicMLGenerator, GherkinGenerator
+)
+
+# LLM clients
+from code2logic.llm import get_client, BaseLLMClient
+
+# Development tools
+from code2logic.tools import run_benchmark, CodeReviewer
+```
+
+## 📋 Output Formats
+
+### Markdown (default)
+
+Human-readable documentation with:
+
+- Project structure tree with hub markers (★)
+- Dependency graphs with PageRank scores
+- Classes with methods and intents
+- Functions with signatures and descriptions
+
+### Compact
+
+Ultra-compact format optimized for LLM context:
+
+```text
+# myproject | 102f 31875L | typescript:79/python:23
+ENTRY: index.ts main.py
+HUBS: evolution-manager llm-orchestrator
+
+[core/evolution]
+  evolution-manager.ts (3719L) C:EvolutionManager | F:createEvolutionManager
+  task-queue.ts (139L) C:TaskQueue,Task
+```
+
+### JSON
+
+Machine-readable format for:
+
+- RAG (Retrieval-Augmented Generation)
+- Database storage
+- Further analysis
+
+## 🔧 Configuration
+
+### Library Status
+
+Check which features are available:
+
+```bash
+code2logic --status
+```
+
+```text
+Library Status:
+  tree_sitter: ✓
+  networkx: ✓
+  rapidfuzz: ✓
+  nltk: ✗
+  spacy: ✗
+```
+
+### LLM Configuration
+
+Manage LLM providers, models, API keys, and routing priorities:
+
+```bash
+code2logic llm status
+code2logic llm set-provider auto
+code2logic llm set-model openrouter nvidia/nemotron-3-nano-30b-a3b:free
+code2logic llm key set openrouter <OPENROUTER_API_KEY>
+code2logic llm priority set-provider openrouter 10
+code2logic llm priority set-mode provider-first
+code2logic llm priority set-llm-model nvidia/nemotron-3-nano-30b-a3b:free 5
+code2logic llm priority set-llm-family nvidia/ 5
+code2logic llm config list
+```
+
+Notes:
+
+- `code2logic llm set-provider auto` enables automatic fallback selection: providers are tried in priority order.
+- API keys should be stored in `.env` (or environment variables), not in `litellm_config.yaml`.
+- These commands write configuration files:
+  - `.env` in the current working directory
+  - `litellm_config.yaml` in the current working directory
+  - `~/.code2logic/llm_config.json` in your home directory
+
+#### Priority modes
+
+You can choose how automatic fallback ordering is computed:
+
+- `provider-first`
+  providers are ordered by provider priority (defaults + overrides)
+- `model-first`
+  providers are ordered by priority rules for the provider's configured model (exact/prefix)
+- `mixed`
+  providers are ordered by the best (lowest) priority from either provider priority or model rules
+
+Configure the mode:
+
+```bash
+code2logic llm priority set-mode provider-first
+code2logic llm priority set-mode model-first
+code2logic llm priority set-mode mixed
+```
+
+Model priority rules are stored in `~/.code2logic/llm_config.json`.
+
+### Python API (Library Status)
+
+```python
+from code2logic import get_library_status
+
+status = get_library_status()
+# {'tree_sitter': True, 'networkx': True, ...}
+```
+
+## 📊 Analysis Features
+
+### Dependency Analysis
+
+- **PageRank** - Identifies most important modules
+- **Hub detection** - Central modules marked with ★
+- **Cycle detection** - Find circular dependencies
+- **Clustering** - Group related modules
+
+### Intent Generation
+
+Functions get human-readable descriptions:
+
+```yaml
+methods:
+  async findById(id:string) -> Promise<User>  # retrieves user by id
+  async createUser(data:UserDTO) -> Promise<User>  # creates user
+  validateEmail(email:string) -> boolean  # validates email
+```
+
+### Similarity Detection
+
+Find duplicate and similar functions:
+
+```yaml
+Similar Functions:
+  core/auth.ts::validateToken:
+    - python/auth.py::validate_token (92%)
+    - services/jwt.ts::verifyToken (85%)
+```
+
+## 🏗️ Architecture
+
+```text
+code2logic/
+├── analyzer.py      # Main orchestrator
+├── parsers.py       # Tree-sitter + fallback parser
+├── dependency.py    # NetworkX dependency analysis
+├── similarity.py    # Rapidfuzz similar detection
+├── intent.py        # NLP intent generation
+├── generators.py    # Output generators (MD/Compact/JSON)
+├── models.py        # Data structures
+└── cli.py           # Command-line interface
+```
+
+## 🔌 Integration Examples
+
+### With Claude/ChatGPT
+
+```python
+from code2logic import analyze_project, CompactGenerator
+
+project = analyze_project("./my-project")
+context = CompactGenerator().generate(project)
+
+# Use in your LLM prompt
+prompt = f"""
+Analyze this codebase and suggest improvements:
+
+{context}
+"""
+```
+
+### With RAG Systems
+
+```python
+import json
+from code2logic import analyze_project, JSONGenerator
+
+project = analyze_project("./my-project")
+data = json.loads(JSONGenerator().generate(project))
+
+# Index in vector DB
+for module in data['modules']:
+    for func in module['functions']:
+        embed_and_store(
+            text=f"{func['name']}: {func['intent']}",
+            metadata={'path': module['path'], 'type': 'function'}
+        )
+```
+
+## 🧪 Development
+
+### Setup
+
+```bash
+git clone https://github.com/wronai/code2logic
+cd code2logic
+poetry install --with dev -E full
+poetry run pre-commit install
+
+# Alternatively, you can use Makefile targets (prefer Poetry if available)
+make install-full
+```
+
+### Tests
+
+```bash
+make test
+make test-cov
+
+# Or directly:
+poetry run pytest
+poetry run pytest --cov=code2logic --cov-report=html
+```
+
+### Type Checking
+
+```bash
+make typecheck
+
+# Or directly:
+poetry run mypy code2logic
+```
+
+### Linting
+
+```bash
+make lint
+make format
+
+# Or directly:
+poetry run ruff check code2logic
+poetry run black code2logic
+```
+
+## 📈 Performance
+
+| Codebase Size | Files | Lines | Time | Output Size |
+| --- | --- | --- | --- | --- |
+| Small | 10 | 1K | <1s | ~5KB |
+| Medium | 100 | 30K | ~2s | ~50KB |
+| Large | 500 | 150K | ~10s | ~200KB |
+
+Compact format is ~10-15x smaller than Markdown.
+
+## 🔬 Code Reproduction Benchmarks
+
+Code2Logic can reproduce code from specifications using LLMs. Benchmark results:
+
+### Format Comparison (Token Efficiency)
+
+| Format | Score | Token Efficiency | Spec Tokens | Runs OK |
+| --- | --- | --- | --- | --- |
+| **YAML** | **71.1%** | 42.1 | **366** | 66.7% |
+| **Markdown** | 65.6% | **48.7** | 385 | **100%** |
+| JSON | 61.9% | 23.7 | 605 | 66.7% |
+| Gherkin | 51.3% | 19.1 | 411 | 66.7% |
+
+### Key Findings
+
+- **YAML is best for score** - 71.1% reproduction accuracy
+- **Markdown is best for token efficiency** - 48.7 score/1000 tokens
+- **YAML uses 39.6% fewer tokens than JSON** with 9.2% higher score
+- **Markdown has 100% runs OK** - generated code always executes
+
+### Run Benchmarks
+
+```bash
+# Token-aware benchmark
+python examples/11_token_benchmark.py --folder tests/samples/ --no-llm
+
+# Async multi-format benchmark
+python examples/09_async_benchmark.py --folder tests/samples/ --no-llm
+
+# Function-level reproduction
+python examples/10_function_reproduction.py --file tests/samples/sample_functions.py --no-llm
+
+python examples/15_unified_benchmark.py --folder tests/samples/ --no-llm
+
+# Terminal markdown rendering demo
+python examples/16_terminal_demo.py --folder tests/samples/
+```
+
+## 🤝 Contributing
+
+Contributions welcome! Please read our [Contributing Guide](CONTRIBUTING.md).
+
+## 📄 License
+
+Apache 2 License - see [LICENSE](LICENSE) for details.
+
+## 📚 Documentation
+
+- [00 - Docs Index](docs/00-index.md) - Documentation home (start here)
+- [01 - Getting Started](docs/01-getting-started.md) - Install and first steps
+- [02 - Configuration](docs/02-configuration.md) - API keys, environment setup
+- [03 - CLI Reference](docs/03-cli-reference.md) - Command-line usage
+- [04 - Python API](docs/04-python-api.md) - Programmatic usage
+- [05 - Output Formats](docs/05-output-formats.md) - Format comparison and usage
+- [06 - Format Specifications](docs/06-format-specifications.md) - Detailed format specs
+- [07 - TOON Format](docs/07-toon.md) - Token-Oriented Object Notation
+- [08 - LLM Integration](docs/08-llm-integration.md) - OpenRouter/Ollama/LiteLLM
+- [09 - LLM Comparison](docs/09-llm-comparison-report.md) - Provider/model comparison
+- [10 - Benchmarking](docs/10-benchmark.md) - Benchmark methodology and results
+- [11 - Repeatability](docs/11-repeatability.md) - Repeatability testing
+- [12 - Examples](docs/12-examples.md) - Usage workflows and examples
+- [13 - Architecture](docs/13-architecture.md) - System design and components
+- [14 - Format Analysis](docs/14-format-analysis.md) - Deeper format evaluation
+
+## 🔗 Links
+
+- [Documentation](https://code2logic.readthedocs.io)
+- [PyPI](https://pypi.org/project/code2logic/)
+- [GitHub](https://github.com/wronai/code2logic)
+- [Issues](https://github.com/wronai/code2logic/issues)
+