codefox 0.3.0__tar.gz → 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. codefox-0.3.2/.python-version +1 -0
  2. {codefox-0.3.0 → codefox-0.3.2}/PKG-INFO +15 -8
  3. {codefox-0.3.0 → codefox-0.3.2}/README.md +14 -7
  4. {codefox-0.3.0 → codefox-0.3.2}/pyproject.toml +1 -1
  5. {codefox-0.3.0 → codefox-0.3.2}/setup.py +12 -6
  6. codefox-0.3.0/.python-version +0 -1
  7. {codefox-0.3.0 → codefox-0.3.2}/.github/workflows/ci.yml +0 -0
  8. {codefox-0.3.0 → codefox-0.3.2}/.gitignore +0 -0
  9. {codefox-0.3.0 → codefox-0.3.2}/LICENSE +0 -0
  10. {codefox-0.3.0 → codefox-0.3.2}/WIKI.md +0 -0
  11. {codefox-0.3.0 → codefox-0.3.2}/assets/logo.png +0 -0
  12. {codefox-0.3.0 → codefox-0.3.2}/assets/work_review.gif +0 -0
  13. {codefox-0.3.0 → codefox-0.3.2}/codefox/__init__.py +0 -0
  14. {codefox-0.3.0 → codefox-0.3.2}/codefox/__main__.py +0 -0
  15. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/__init__.py +0 -0
  16. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/base_api.py +0 -0
  17. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/gemini.py +0 -0
  18. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/model_enum.py +0 -0
  19. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/ollama.py +0 -0
  20. {codefox-0.3.0 → codefox-0.3.2}/codefox/api/openrouter.py +0 -0
  21. {codefox-0.3.0 → codefox-0.3.2}/codefox/base_cli.py +0 -0
  22. {codefox-0.3.0 → codefox-0.3.2}/codefox/cli_manager.py +0 -0
  23. {codefox-0.3.0 → codefox-0.3.2}/codefox/init.py +0 -0
  24. {codefox-0.3.0 → codefox-0.3.2}/codefox/list.py +0 -0
  25. {codefox-0.3.0 → codefox-0.3.2}/codefox/main.py +0 -0
  26. {codefox-0.3.0 → codefox-0.3.2}/codefox/prompts/__init__.py +0 -0
  27. {codefox-0.3.0 → codefox-0.3.2}/codefox/prompts/audit_system.py +0 -0
  28. {codefox-0.3.0 → codefox-0.3.2}/codefox/prompts/prompt_template.py +0 -0
  29. {codefox-0.3.0 → codefox-0.3.2}/codefox/prompts/template.py +0 -0
  30. {codefox-0.3.0 → codefox-0.3.2}/codefox/scan.py +0 -0
  31. {codefox-0.3.0 → codefox-0.3.2}/codefox/utils/__init__.py +0 -0
  32. {codefox-0.3.0 → codefox-0.3.2}/codefox/utils/helper.py +0 -0
  33. {codefox-0.3.0 → codefox-0.3.2}/codefox/utils/local_rag.py +0 -0
  34. {codefox-0.3.0 → codefox-0.3.2}/requirements-dev.txt +0 -0
  35. {codefox-0.3.0 → codefox-0.3.2}/requirements.in +0 -0
  36. {codefox-0.3.0 → codefox-0.3.2}/requirements.txt +0 -0
  37. {codefox-0.3.0 → codefox-0.3.2}/tests/conftest.py +0 -0
  38. {codefox-0.3.0 → codefox-0.3.2}/tests/test_base_api_config.py +0 -0
  39. {codefox-0.3.0 → codefox-0.3.2}/tests/test_cli_manager.py +0 -0
  40. {codefox-0.3.0 → codefox-0.3.2}/tests/test_helper.py +0 -0
  41. {codefox-0.3.0 → codefox-0.3.2}/tests/test_model_enum.py +0 -0
  42. {codefox-0.3.0 → codefox-0.3.2}/tests/test_prompt_template.py +0 -0
  43. {codefox-0.3.0 → codefox-0.3.2}/uv.lock +0 -0
@@ -0,0 +1 @@
1
+ 3.12
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: codefox
3
- Version: 0.3.0
3
+ Version: 0.3.2
4
4
  Summary: CodeFox CLI - code auditing and code review tool
5
5
  License-File: LICENSE
6
6
  Requires-Python: >=3.11
@@ -25,7 +25,7 @@ Requires-Dist: types-requests>=2.31.0; extra == 'dev'
25
25
  Description-Content-Type: text/markdown
26
26
 
27
27
  <p align="center">
28
- <img src="assets/logo.png" alt="CodeFox logo" width="120" />
28
+ <img src="https://raw.githubusercontent.com/URLbug/CodeFox-CLI/refs/heads/main/assets/logo.png" alt="CodeFox logo" width="120" />
29
29
  </p>
30
30
 
31
31
  <h1 align="center">CodeFox-CLI</h1>
@@ -37,10 +37,9 @@ Description-Content-Type: text/markdown
37
37
  <a href="https://github.com/URLbug/CodeFox-CLI/actions"><img src="https://github.com/URLbug/CodeFox-CLI/workflows/CI/badge.svg" alt="CI" /></a>
38
38
  <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" /></a>
39
39
  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11+-green.svg" alt="Python 3.11+" /></a>
40
+ <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/WIKI.md"><img src="https://img.shields.io/badge/docs-WIKI-blue?logo=readme" alt="Wiki" /></a>
40
41
  </p>
41
42
 
42
- ---
43
-
44
43
  ## 🦊 Overview
45
44
 
46
45
  **CodeFox-CLI** is an intelligent automated code review system that takes over routine security and code quality checks, allowing senior developers to focus on architecture and complex tasks.
@@ -54,7 +53,7 @@ Unlike traditional linters, CodeFox understands the context of the entire projec
54
53
  | RAG over your codebase for relevant hints | CLI-first: `git diff` → review in seconds |
55
54
 
56
55
  <p align="center">
57
- <img src="assets/work_review.gif" alt="CodeFox scan demo" width="800" />
56
+ <img src="https://raw.githubusercontent.com/URLbug/CodeFox-CLI/refs/heads/main/assets/work_review.gif" alt="CodeFox scan demo" width="800" />
58
57
  </p>
59
58
 
60
59
  ---
@@ -81,12 +80,14 @@ python3 -m pip install -e .
81
80
  🐍 Using pip
82
81
 
83
82
  ```bash
84
- python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
83
+ python3 -m pip install codefox
84
+ # or python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
85
85
  ```
86
86
 
87
87
  ⚡ Using uv (recommended for CLI usage)
88
88
  ```bash
89
- uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
89
+ uv tool install codefox
90
+ # or uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
90
91
  ```
91
92
 
92
93
  ---
@@ -129,7 +130,7 @@ Specifies paths that should not be uploaded to the File Store.
129
130
 
130
131
  **Model settings:** `./.codefox.yml`
131
132
  Used for fine-grained configuration of the analysis behavior and model parameters (such as model selection, temperature, review rules, baseline, and prompts).
132
- For detailed configuration options and examples, see [wiki](WIKI.md).
133
+ For detailed configuration options and examples, see [**WIKI.md**](WIKI.md).
133
134
 
134
135
  Example config used in the demo above (Ollama + qwen3-coder):
135
136
 
@@ -160,6 +161,12 @@ Stores the API token for the model. This file is used by the CLI for authenticat
160
161
 
161
162
  ---
162
163
 
164
+ ## 📚 Documentation
165
+
166
+ **Full configuration reference and examples:** [**WIKI.md**](https://github.com/URLbug/CodeFox-CLI/blob/main/WIKI.md) - provider settings, model options, review rules, prompts, and more.
167
+
168
+ ---
169
+
163
170
  ## 🧩 Commands
164
171
 
165
172
  | Command | Description |
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <img src="assets/logo.png" alt="CodeFox logo" width="120" />
2
+ <img src="https://raw.githubusercontent.com/URLbug/CodeFox-CLI/refs/heads/main/assets/logo.png" alt="CodeFox logo" width="120" />
3
3
  </p>
4
4
 
5
5
  <h1 align="center">CodeFox-CLI</h1>
@@ -11,10 +11,9 @@
11
11
  <a href="https://github.com/URLbug/CodeFox-CLI/actions"><img src="https://github.com/URLbug/CodeFox-CLI/workflows/CI/badge.svg" alt="CI" /></a>
12
12
  <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" /></a>
13
13
  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11+-green.svg" alt="Python 3.11+" /></a>
14
+ <a href="https://github.com/URLbug/CodeFox-CLI/blob/main/WIKI.md"><img src="https://img.shields.io/badge/docs-WIKI-blue?logo=readme" alt="Wiki" /></a>
14
15
  </p>
15
16
 
16
- ---
17
-
18
17
  ## 🦊 Overview
19
18
 
20
19
  **CodeFox-CLI** is an intelligent automated code review system that takes over routine security and code quality checks, allowing senior developers to focus on architecture and complex tasks.
@@ -28,7 +27,7 @@ Unlike traditional linters, CodeFox understands the context of the entire projec
28
27
  | RAG over your codebase for relevant hints | CLI-first: `git diff` → review in seconds |
29
28
 
30
29
  <p align="center">
31
- <img src="assets/work_review.gif" alt="CodeFox scan demo" width="800" />
30
+ <img src="https://raw.githubusercontent.com/URLbug/CodeFox-CLI/refs/heads/main/assets/work_review.gif" alt="CodeFox scan demo" width="800" />
32
31
  </p>
33
32
 
34
33
  ---
@@ -55,12 +54,14 @@ python3 -m pip install -e .
55
54
  🐍 Using pip
56
55
 
57
56
  ```bash
58
- python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
57
+ python3 -m pip install codefox
58
+ # or python3 -m pip install git+https://github.com/URLbug/CodeFox-CLI.git@main
59
59
  ```
60
60
 
61
61
  ⚡ Using uv (recommended for CLI usage)
62
62
  ```bash
63
- uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
63
+ uv tool install codefox
64
+ # or uv tool install git+https://github.com/URLbug/CodeFox-CLI.git@main
64
65
  ```
65
66
 
66
67
  ---
@@ -103,7 +104,7 @@ Specifies paths that should not be uploaded to the File Store.
103
104
 
104
105
  **Model settings:** `./.codefox.yml`
105
106
  Used for fine-grained configuration of the analysis behavior and model parameters (such as model selection, temperature, review rules, baseline, and prompts).
106
- For detailed configuration options and examples, see [wiki](WIKI.md).
107
+ For detailed configuration options and examples, see [**WIKI.md**](WIKI.md).
107
108
 
108
109
  Example config used in the demo above (Ollama + qwen3-coder):
109
110
 
@@ -134,6 +135,12 @@ Stores the API token for the model. This file is used by the CLI for authenticat
134
135
 
135
136
  ---
136
137
 
138
+ ## 📚 Documentation
139
+
140
+ **Full configuration reference and examples:** [**WIKI.md**](https://github.com/URLbug/CodeFox-CLI/blob/main/WIKI.md) - provider settings, model options, review rules, prompts, and more.
141
+
142
+ ---
143
+
137
144
  ## 🧩 Commands
138
145
 
139
146
  | Command | Description |
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "codefox"
3
- version = "0.3.0"
3
+ version = "0.3.2"
4
4
  description = "CodeFox CLI - code auditing and code review tool"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.11"
@@ -7,7 +7,7 @@ README = (HERE / "README.txt").read_text(encoding="utf-8") if (HERE / "README.tx
7
7
 
8
8
  setup(
9
9
  name="codefox",
10
- version="0.3.0",
10
+ version="0.3.2",
11
11
  description="CodeFox CLI - code auditing and code review tool",
12
12
  long_description=README,
13
13
  long_description_content_type="text/plain",
@@ -15,11 +15,17 @@ setup(
15
15
  packages=find_packages(),
16
16
  include_package_data=True,
17
17
  install_requires=[
18
- "typer",
19
- "rich",
20
- "python-dotenv",
21
- "GitPython",
22
- "google-genai",
18
+ "faiss-cpu>=1.7.4",
19
+ "fastembed>=0.3.0",
20
+ "gitpython==3.1.46",
21
+ "google-genai==1.63.0",
22
+ "numpy>=1.24.0",
23
+ "python-dotenv==1.2.1",
24
+ "pyyaml==6.0.3",
25
+ "rich==14.3.2",
26
+ "typer==0.23.1",
27
+ "openai==2.21.0",
28
+ "ollama==0.6.1",
23
29
  ],
24
30
  entry_points={
25
31
  "console_scripts": [
@@ -1 +0,0 @@
1
- 3.14
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes