codebread 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

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.
codebread/__init__.py CHANGED
@@ -1,3 +1,3 @@
1
1
  """CodeBread — slice open a codebase and see its internal structure."""
2
2
 
3
- __version__ = "1.0.0"
3
+ __version__ = "1.0.1"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: codebread
3
- Version: 1.0.0
3
+ Version: 1.0.1
4
4
  Summary: Interactive codebase analyzer & visualizer — slice open a project and see how it's wired together.
5
5
  Author: Danial Irsyad
6
6
  License: MIT
@@ -13,7 +13,7 @@ Requires-Dist: pathspec>=0.11; extra == "full"
13
13
  Dynamic: license-file
14
14
 
15
15
  <p align="center">
16
- <img src="assets/logo-wordmark.png" alt="CodeBread" width="360">
16
+ <img src="https://cdn.jsdelivr.net/gh/honow48-tech/CodeBread@main/assets/logo-wordmark.png" alt="CodeBread" width="360">
17
17
  </p>
18
18
 
19
19
  <p align="center">
@@ -22,7 +22,7 @@ Dynamic: license-file
22
22
  </p>
23
23
 
24
24
  <p align="center">
25
- <img alt="version" src="https://img.shields.io/badge/version-1.0.0-2dd4bf">
25
+ <img alt="version" src="https://img.shields.io/badge/version-1.0.1-2dd4bf">
26
26
  <img alt="python" src="https://img.shields.io/badge/python-3.9%2B-0284c7">
27
27
  <img alt="deps" src="https://img.shields.io/badge/required%20dependencies-none-2dd4bf">
28
28
  <img alt="license" src="https://img.shields.io/badge/license-MIT-8b5cf6">
@@ -74,27 +74,30 @@ That's it. Clone it, run it, nothing to compile.
74
74
  ## Install
75
75
 
76
76
  ```bash
77
- # option A: install the CLI
78
- pip install .
79
-
80
- # option B: don't install anything, just run it
81
- python codebread.py --path /path/to/project
77
+ pip install codebread
82
78
  ```
83
79
 
84
80
  Optional extra (better `.gitignore` matching while scanning):
85
81
 
86
82
  ```bash
87
- pip install .[full] # adds pathspec
83
+ pip install codebread[full] # adds pathspec
88
84
  ```
89
85
 
90
86
  Requires **Python 3.9+**. Nothing else.
91
87
 
88
+ Prefer running from source instead (e.g. to contribute)?
89
+
90
+ ```bash
91
+ git clone https://github.com/honow48-tech/CodeBread.git
92
+ cd CodeBread
93
+ pip install . # or: python codebread.py --path /path/to/project
94
+ ```
95
+
92
96
  ## Use
93
97
 
94
98
  ```bash
95
99
  codebread --path /path/to/project # scan + open the UI in your browser
96
100
  codebread # prompts for the path
97
- python codebread.py --path . # uninstalled, same thing
98
101
  ```
99
102
 
100
103
  That's the whole quick start: point it at a folder, a browser tab opens with
@@ -1,4 +1,4 @@
1
- codebread/__init__.py,sha256=BC-wwjQfPOvr7SvqouJDXsRzLwI89Hv9LPFCODM5dDc,97
1
+ codebread/__init__.py,sha256=zaQz04FV7Jd-aoPIR3qYYkZq1BbI0XO3OWKdY1hjya0,97
2
2
  codebread/analyzer.py,sha256=7uf00Lw5jjtsA4-fb8x2bUsoZybyPNeVQsXSBx1bPhY,3061
3
3
  codebread/classifier.py,sha256=jehD-XQ80CP_O4x9YRi4JQqzd4AaHxKpzI83wLG1yvM,4067
4
4
  codebread/cli.py,sha256=AMvwk29cOJDjsI-I07pCGbqogdtq1Y6HWnT52FHYyLs,4072
@@ -16,9 +16,9 @@ codebread/parsers/python_parser.py,sha256=QnhCLx01bKYLYqav33cI27qbEQNPUiXnS5uN7c
16
16
  codebread/web/app.js,sha256=P1zpCHNMyczAuLWL9zM5htl9E3wG3jJdpZ6orLhixTM,65672
17
17
  codebread/web/index.html,sha256=6YqjC_wO3pfqyG_11uIhvRM16Wagu2l8eSOs1FNc-UY,8693
18
18
  codebread/web/style.css,sha256=fiq1bC-I1bC6-6MxRn0blQwGOjO_fdClPrhf5W7zqPw,23729
19
- codebread-1.0.0.dist-info/licenses/LICENSE,sha256=okINupIvMgiuOlvMVpsM9DT5jb6QQmKBd--yfZq4bjc,1070
20
- codebread-1.0.0.dist-info/METADATA,sha256=qzULyaRVsH_7ybNluHcLL-2CLAsZtxRgSAW0cQq5j7g,11258
21
- codebread-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
22
- codebread-1.0.0.dist-info/entry_points.txt,sha256=ItG61aUP1YTvA_zA-jlUshBc5BPpJDpCyVnsyaxNXKA,49
23
- codebread-1.0.0.dist-info/top_level.txt,sha256=KctFB7UQb4tN9YotaJD95GuHWIQuoO5VqyLdo_gEswQ,10
24
- codebread-1.0.0.dist-info/RECORD,,
19
+ codebread-1.0.1.dist-info/licenses/LICENSE,sha256=okINupIvMgiuOlvMVpsM9DT5jb6QQmKBd--yfZq4bjc,1070
20
+ codebread-1.0.1.dist-info/METADATA,sha256=jsimg1QlF58mJVpAOs4L2Oh12i7R_kE0GSDGgBhHCHM,11367
21
+ codebread-1.0.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
22
+ codebread-1.0.1.dist-info/entry_points.txt,sha256=ItG61aUP1YTvA_zA-jlUshBc5BPpJDpCyVnsyaxNXKA,49
23
+ codebread-1.0.1.dist-info/top_level.txt,sha256=KctFB7UQb4tN9YotaJD95GuHWIQuoO5VqyLdo_gEswQ,10
24
+ codebread-1.0.1.dist-info/RECORD,,