diff --git a/codex-lens/LICENSE b/codex-lens/LICENSE new file mode 100644 index 00000000..8e31ab6b --- /dev/null +++ b/codex-lens/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 CodexLens Contributors + +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. diff --git a/codex-lens/README.md b/codex-lens/README.md new file mode 100644 index 00000000..66f754f1 --- /dev/null +++ b/codex-lens/README.md @@ -0,0 +1,59 @@ +# CodexLens + +CodexLens is a multi-modal code analysis platform designed to provide comprehensive code understanding and analysis capabilities. + +## Features + +- **Multi-language Support**: Analyze code in Python, JavaScript, TypeScript and more using Tree-sitter parsers +- **Semantic Search**: Find relevant code snippets using semantic understanding with fastembed and HNSWLIB +- **Code Parsing**: Advanced code structure parsing with tree-sitter +- **Flexible Architecture**: Modular design for easy extension and customization + +## Installation + +### Basic Installation + +```bash +pip install codex-lens +``` + +### With Semantic Search + +```bash +pip install codex-lens[semantic] +``` + +### With GPU Acceleration (NVIDIA CUDA) + +```bash +pip install codex-lens[semantic-gpu] +``` + +### With DirectML (Windows - NVIDIA/AMD/Intel) + +```bash +pip install codex-lens[semantic-directml] +``` + +### With All Optional Features + +```bash +pip install codex-lens[full] +``` + +## Requirements + +- Python >= 3.10 +- See `pyproject.toml` for detailed dependency list + +## Development + +This project uses setuptools for building and packaging. + +## License + +MIT License + +## Authors + +CodexLens Contributors diff --git a/codex-lens/pyproject.toml b/codex-lens/pyproject.toml index ac8009a8..be00a4cb 100644 --- a/codex-lens/pyproject.toml +++ b/codex-lens/pyproject.toml @@ -8,7 +8,7 @@ version = "0.1.0" description = "CodexLens multi-modal code analysis platform" readme = "README.md" requires-python = ">=3.10" -license = { text = "MIT" } +license = "MIT" authors = [ { name = "CodexLens contributors" } ]