codebase-brief 0.1.3__tar.gz → 0.1.4__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.
@@ -1,5 +1,10 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.4
4
+
5
+ - Refresh the package listing with the current first-run instructions, product fit, limitations, and importer-aware `--base` behavior.
6
+ - Link package metadata to the project site and keep source-code and issue links explicit.
7
+
3
8
  ## 0.1.3
4
9
 
5
10
  - Find task-matching snippets deeper inside selected source files and show their line ranges instead of always starting at the file's beginning.
@@ -1,10 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: codebase-brief
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Local-first CLI that builds task-focused context briefs from code repositories
5
5
  Author: Mohamed Maggy
6
6
  License-Expression: MIT
7
- Project-URL: Homepage, https://github.com/mohamed1111111m/codebase-brief
7
+ Project-URL: Homepage, https://mohamed1111111m.github.io/codebase-brief/
8
8
  Project-URL: Repository, https://github.com/mohamed1111111m/codebase-brief
9
9
  Project-URL: Issues, https://github.com/mohamed1111111m/codebase-brief/issues
10
10
  Keywords: developer-tools,codebase,context,cli
@@ -33,11 +33,13 @@ Dynamic: license-file
33
33
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
34
34
  [![MIT License](https://img.shields.io/badge/license-MIT-8A63D2.svg)](LICENSE)
35
35
 
36
- **Browser-based coding chats cannot see your local repo.** Codebase Brief turns one coding task into a short, reviewable file shortlist—with excerpts, reasons, and source paths—so you can give ChatGPT, Claude, or another chat the project context it cannot inspect itself.
36
+ **Need a reviewed, task-specific handoff for a coding chat?** Codebase Brief turns one coding task into a short file shortlist—with excerpts, reasons, and source paths—when your assistant cannot access the project directly or you want to choose exactly what context to share.
37
37
 
38
- It works locally, without an AI service or account. Review the brief, save it, or paste it into ChatGPT, Claude, or another assistant that cannot inspect your local working tree.
38
+ It works locally, without an AI service or account. Review the brief, save it, or paste it into the assistant you want to use.
39
39
 
40
- **Best fit:** a browser chat that cannot inspect your local files, or a task where you want to choose exactly what context to share. If your coding agent already reads and indexes the working tree, its built-in repo tools may be enough.
40
+ ## When Codebase Brief fits
41
+
42
+ It is most useful when your chat cannot access the current local project, or when you want a small, reviewable handoff instead of giving an assistant broad repo access. Some tools now offer local-folder or GitHub-repository access—for example, [ChatGPT Work and Codex](https://help.openai.com/en/articles/20001275), [Claude's local and GitHub connections](https://support.anthropic.com/en/articles/11725091-when-to-use-desktop-and-web-connectors), and [Gemini's GitHub import](https://support.google.com/gemini/answer/16176929). Availability depends on the tool, plan, and setup. If your assistant can already read the current working tree and do the task safely, its built-in repo access may be simpler; you may not need Codebase Brief.
41
43
 
42
44
  ## See it in action
43
45
 
@@ -53,7 +55,7 @@ The first image is a terminal-style rendering of the app's actual numbered menu.
53
55
 
54
56
  You need Python 3.10 or newer. Git is optional, but required for recent-history and base-diff details.
55
57
 
56
- The current PyPI release is `0.1.3` and includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
58
+ The current PyPI package includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
57
59
 
58
60
  ```powershell
59
61
  pipx install codebase-brief
@@ -8,11 +8,13 @@
8
8
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
9
9
  [![MIT License](https://img.shields.io/badge/license-MIT-8A63D2.svg)](LICENSE)
10
10
 
11
- **Browser-based coding chats cannot see your local repo.** Codebase Brief turns one coding task into a short, reviewable file shortlist—with excerpts, reasons, and source paths—so you can give ChatGPT, Claude, or another chat the project context it cannot inspect itself.
11
+ **Need a reviewed, task-specific handoff for a coding chat?** Codebase Brief turns one coding task into a short file shortlist—with excerpts, reasons, and source paths—when your assistant cannot access the project directly or you want to choose exactly what context to share.
12
12
 
13
- It works locally, without an AI service or account. Review the brief, save it, or paste it into ChatGPT, Claude, or another assistant that cannot inspect your local working tree.
13
+ It works locally, without an AI service or account. Review the brief, save it, or paste it into the assistant you want to use.
14
14
 
15
- **Best fit:** a browser chat that cannot inspect your local files, or a task where you want to choose exactly what context to share. If your coding agent already reads and indexes the working tree, its built-in repo tools may be enough.
15
+ ## When Codebase Brief fits
16
+
17
+ It is most useful when your chat cannot access the current local project, or when you want a small, reviewable handoff instead of giving an assistant broad repo access. Some tools now offer local-folder or GitHub-repository access—for example, [ChatGPT Work and Codex](https://help.openai.com/en/articles/20001275), [Claude's local and GitHub connections](https://support.anthropic.com/en/articles/11725091-when-to-use-desktop-and-web-connectors), and [Gemini's GitHub import](https://support.google.com/gemini/answer/16176929). Availability depends on the tool, plan, and setup. If your assistant can already read the current working tree and do the task safely, its built-in repo access may be simpler; you may not need Codebase Brief.
16
18
 
17
19
  ## See it in action
18
20
 
@@ -28,7 +30,7 @@ The first image is a terminal-style rendering of the app's actual numbered menu.
28
30
 
29
31
  You need Python 3.10 or newer. Git is optional, but required for recent-history and base-diff details.
30
32
 
31
- The current PyPI release is `0.1.3` and includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
33
+ The current PyPI package includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
32
34
 
33
35
  ```powershell
34
36
  pipx install codebase-brief
@@ -1,10 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: codebase-brief
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Local-first CLI that builds task-focused context briefs from code repositories
5
5
  Author: Mohamed Maggy
6
6
  License-Expression: MIT
7
- Project-URL: Homepage, https://github.com/mohamed1111111m/codebase-brief
7
+ Project-URL: Homepage, https://mohamed1111111m.github.io/codebase-brief/
8
8
  Project-URL: Repository, https://github.com/mohamed1111111m/codebase-brief
9
9
  Project-URL: Issues, https://github.com/mohamed1111111m/codebase-brief/issues
10
10
  Keywords: developer-tools,codebase,context,cli
@@ -33,11 +33,13 @@ Dynamic: license-file
33
33
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
34
34
  [![MIT License](https://img.shields.io/badge/license-MIT-8A63D2.svg)](LICENSE)
35
35
 
36
- **Browser-based coding chats cannot see your local repo.** Codebase Brief turns one coding task into a short, reviewable file shortlist—with excerpts, reasons, and source paths—so you can give ChatGPT, Claude, or another chat the project context it cannot inspect itself.
36
+ **Need a reviewed, task-specific handoff for a coding chat?** Codebase Brief turns one coding task into a short file shortlist—with excerpts, reasons, and source paths—when your assistant cannot access the project directly or you want to choose exactly what context to share.
37
37
 
38
- It works locally, without an AI service or account. Review the brief, save it, or paste it into ChatGPT, Claude, or another assistant that cannot inspect your local working tree.
38
+ It works locally, without an AI service or account. Review the brief, save it, or paste it into the assistant you want to use.
39
39
 
40
- **Best fit:** a browser chat that cannot inspect your local files, or a task where you want to choose exactly what context to share. If your coding agent already reads and indexes the working tree, its built-in repo tools may be enough.
40
+ ## When Codebase Brief fits
41
+
42
+ It is most useful when your chat cannot access the current local project, or when you want a small, reviewable handoff instead of giving an assistant broad repo access. Some tools now offer local-folder or GitHub-repository access—for example, [ChatGPT Work and Codex](https://help.openai.com/en/articles/20001275), [Claude's local and GitHub connections](https://support.anthropic.com/en/articles/11725091-when-to-use-desktop-and-web-connectors), and [Gemini's GitHub import](https://support.google.com/gemini/answer/16176929). Availability depends on the tool, plan, and setup. If your assistant can already read the current working tree and do the task safely, its built-in repo access may be simpler; you may not need Codebase Brief.
41
43
 
42
44
  ## See it in action
43
45
 
@@ -53,7 +55,7 @@ The first image is a terminal-style rendering of the app's actual numbered menu.
53
55
 
54
56
  You need Python 3.10 or newer. Git is optional, but required for recent-history and base-diff details.
55
57
 
56
- The current PyPI release is `0.1.3` and includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
58
+ The current PyPI package includes the review-feedback summary, importer-aware `--base` selection, and a sample demo. Install it with `pipx`:
57
59
 
58
60
  ```powershell
59
61
  pipx install codebase-brief
@@ -24,7 +24,7 @@ MAX_KEY_FILES = 12
24
24
  MAX_SELECTION_CHOICES = 30
25
25
  MAX_DISCOVERED_FILES = 20_000
26
26
  IMPORT_SUFFIXES = {".py", ".js", ".jsx", ".ts", ".tsx", ".mjs", ".cjs", ".mts", ".cts"}
27
- VERSION = "0.1.3"
27
+ VERSION = "0.1.4"
28
28
  MANIFESTS = (
29
29
  "package.json", "pyproject.toml", "requirements.txt", "Cargo.toml",
30
30
  "go.mod", "Gemfile", "composer.json", "pom.xml",
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "codebase-brief"
7
- version = "0.1.3"
7
+ version = "0.1.4"
8
8
  description = "Local-first CLI that builds task-focused context briefs from code repositories"
9
9
  readme = "README.md"
10
10
  license = "MIT"
@@ -27,7 +27,7 @@ classifiers = [
27
27
  ]
28
28
 
29
29
  [project.urls]
30
- Homepage = "https://github.com/mohamed1111111m/codebase-brief"
30
+ Homepage = "https://mohamed1111111m.github.io/codebase-brief/"
31
31
  Repository = "https://github.com/mohamed1111111m/codebase-brief"
32
32
  Issues = "https://github.com/mohamed1111111m/codebase-brief/issues"
33
33
 
@@ -6,7 +6,7 @@ import unittest
6
6
  from pathlib import Path
7
7
  from unittest.mock import patch
8
8
 
9
- from context_inject.cli import DEFAULT_BUDGET_TOKENS, MAX_CHARS, MAX_FILE_BYTES, MAX_KEY_FILES, choose_files, compact, copy_to_clipboard, gather, interactive, local_imports, main, read_excerpt, read_task_excerpt, redact, review_feedback, safe_path, suggest_file_details, suggest_files
9
+ from context_inject.cli import DEFAULT_BUDGET_TOKENS, MAX_CHARS, MAX_FILE_BYTES, MAX_KEY_FILES, VERSION, choose_files, compact, copy_to_clipboard, gather, interactive, local_imports, main, read_excerpt, read_task_excerpt, redact, review_feedback, safe_path, suggest_file_details, suggest_files
10
10
 
11
11
 
12
12
  class ContextInjectTests(unittest.TestCase):
@@ -501,7 +501,7 @@ class ContextInjectTests(unittest.TestCase):
501
501
  plain = __import__("re").sub(r"\x1b\[[0-9;]*m", "", output.getvalue())
502
502
  self.assertIn("CODEBASE", plain)
503
503
  self.assertIn("BRIEF", plain)
504
- self.assertIn("v0.1.3", plain)
504
+ self.assertIn(f"v{VERSION}", plain)
505
505
  self.assertIn("Meet Briefy - your repo guide", plain)
506
506
  self.assertIn("WHAT THIS DOES", plain)
507
507
  self.assertIn("Makes a short guide to your project for an AI coding assistant", plain)
File without changes
File without changes