sourcecode 0.1.0__py3-none-any.whl → 0.1.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.
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sourcecode
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.1
|
|
4
4
|
Summary: Genera un mapa de contexto estructurado de proyectos de software para agentes IA
|
|
5
5
|
License: MIT
|
|
6
6
|
Requires-Python: >=3.9
|
|
@@ -16,61 +16,61 @@ Description-Content-Type: text/markdown
|
|
|
16
16
|
|
|
17
17
|
# sourcecode
|
|
18
18
|
|
|
19
|
-
`sourcecode`
|
|
19
|
+
`sourcecode` generates a structured project context map so an agent can quickly understand a repository's stack, entry points, and overall shape.
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Installation
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
24
|
pip install sourcecode
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
Requires Python `3.9+`.
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Quick Start
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Analyze the current directory as JSON:
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
sourcecode .
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
Generate a compact view for prompts or handoff:
|
|
38
38
|
|
|
39
39
|
```bash
|
|
40
40
|
sourcecode --compact .
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
Analyze another directory and write YAML to a file:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
sourcecode --format yaml --output sourcecode.yaml /
|
|
46
|
+
sourcecode --format yaml --output sourcecode.yaml /path/to/project
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
Show the version:
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
52
|
sourcecode --version
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
Main options:
|
|
56
56
|
|
|
57
|
-
- `--format json|yaml`:
|
|
58
|
-
- `--output PATH`:
|
|
59
|
-
- `--compact`:
|
|
60
|
-
- `--depth INTEGER`:
|
|
61
|
-
- `--no-redact`:
|
|
57
|
+
- `--format json|yaml`: output format.
|
|
58
|
+
- `--output PATH`: write to a file instead of `stdout`.
|
|
59
|
+
- `--compact`: return a reduced view with `schema_version`, `project_type`, `stacks`, `entry_points`, and `file_tree_depth1`.
|
|
60
|
+
- `--depth INTEGER`: maximum file tree depth.
|
|
61
|
+
- `--no-redact`: disable secret redaction.
|
|
62
62
|
|
|
63
|
-
##
|
|
63
|
+
## What It Detects
|
|
64
64
|
|
|
65
|
-
- Stacks: Node.js, Python, Go, Rust, Java, PHP, Ruby
|
|
66
|
-
- Frameworks
|
|
67
|
-
- `project_type`: `webapp`, `api`, `library`, `cli`, `fullstack`, `monorepo
|
|
68
|
-
- `entry_points
|
|
69
|
-
-
|
|
65
|
+
- Stacks: Node.js, Python, Go, Rust, Java, PHP, Ruby, and Dart.
|
|
66
|
+
- Frameworks associated with each stack when enough signals are present.
|
|
67
|
+
- `project_type`: `webapp`, `api`, `library`, `cli`, `fullstack`, `monorepo`, or `unknown`.
|
|
68
|
+
- Relevant `entry_points`, such as `main.py`, `cmd/api/main.go`, or `app/page.tsx`.
|
|
69
|
+
- Workspace roots in multi-stack or monorepo repositories.
|
|
70
70
|
|
|
71
|
-
##
|
|
71
|
+
## Compact Example
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
Real output from a Next.js fixture:
|
|
74
74
|
|
|
75
75
|
```json
|
|
76
76
|
{
|
|
@@ -115,9 +115,9 @@ Salida real de un fixture Next.js:
|
|
|
115
115
|
}
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
-
##
|
|
118
|
+
## Monorepo Example
|
|
119
119
|
|
|
120
|
-
|
|
120
|
+
In a monorepo, each stack includes its own `root` and `workspace`, and one of them is marked as `primary`.
|
|
121
121
|
|
|
122
122
|
```json
|
|
123
123
|
{
|
|
@@ -145,25 +145,25 @@ En un monorepo, cada stack incluye su `root` y `workspace`, y uno de ellos queda
|
|
|
145
145
|
|
|
146
146
|
## Output
|
|
147
147
|
|
|
148
|
-
|
|
148
|
+
The full schema includes:
|
|
149
149
|
|
|
150
|
-
- `metadata`: version
|
|
151
|
-
- `file_tree`:
|
|
152
|
-
- `stacks`:
|
|
153
|
-
- `project_type`:
|
|
154
|
-
- `entry_points`:
|
|
150
|
+
- `metadata`: schema version, timestamp, `sourcecode` version, and analyzed path.
|
|
151
|
+
- `file_tree`: repository tree where `null` represents a file and an object represents a directory.
|
|
152
|
+
- `stacks`: stack detections with confidence, frameworks, manifests, `primary`, `root`, `workspace`, and `signals`.
|
|
153
|
+
- `project_type`: overall project classification.
|
|
154
|
+
- `entry_points`: detected entry points by stack.
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
Detailed reference: [docs/schema.md](/Users/user/Documents/workspace/atlas/atlas-cli/docs/schema.md).
|
|
157
157
|
|
|
158
|
-
##
|
|
158
|
+
## Development
|
|
159
159
|
|
|
160
|
-
|
|
160
|
+
Editable install with development dependencies:
|
|
161
161
|
|
|
162
162
|
```bash
|
|
163
163
|
pip install -e ".[dev]"
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
|
|
166
|
+
Local validation:
|
|
167
167
|
|
|
168
168
|
```bash
|
|
169
169
|
ruff check src tests
|
|
@@ -20,7 +20,7 @@ sourcecode/detectors/project.py,sha256=Fu3N_5ZKtv5b0F7i8Om36k_SZKvm24nRURkHyLogp
|
|
|
20
20
|
sourcecode/detectors/python.py,sha256=DMrlKXapsaRu8jVmO-w-FfnFVXTmQnmpQTaV2PBvIZA,4875
|
|
21
21
|
sourcecode/detectors/ruby.py,sha256=3_Hd5YqlErpTtyTRcUTPnMp1TF92hT-TnYYeclLbF1c,1625
|
|
22
22
|
sourcecode/detectors/rust.py,sha256=iUz9lE4HfBy8CBaDwGhfh6kLsNIovrH2ay2v3y6qNDc,2298
|
|
23
|
-
sourcecode-0.1.
|
|
24
|
-
sourcecode-0.1.
|
|
25
|
-
sourcecode-0.1.
|
|
26
|
-
sourcecode-0.1.
|
|
23
|
+
sourcecode-0.1.1.dist-info/METADATA,sha256=YqiDeYoUkKdnYy8NWiJgGLBiiCKta1P8FP2qWTO0pBg,4086
|
|
24
|
+
sourcecode-0.1.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
|
|
25
|
+
sourcecode-0.1.1.dist-info/entry_points.txt,sha256=voDtdlGU2-jR3wCZpQoOls_0eUKaDVCKIfajGHFDATs,50
|
|
26
|
+
sourcecode-0.1.1.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|