torchlight-spark 0.1.0__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.
- torchlight_spark-0.1.0/CHANGELOG.md +10 -0
- torchlight_spark-0.1.0/CONTRIBUTING.md +106 -0
- torchlight_spark-0.1.0/LICENSE +201 -0
- torchlight_spark-0.1.0/MANIFEST.in +3 -0
- torchlight_spark-0.1.0/NOTICE +4 -0
- torchlight_spark-0.1.0/PKG-INFO +90 -0
- torchlight_spark-0.1.0/README.md +67 -0
- torchlight_spark-0.1.0/SECURITY.md +21 -0
- torchlight_spark-0.1.0/main.py +9 -0
- torchlight_spark-0.1.0/pyproject.toml +42 -0
- torchlight_spark-0.1.0/requirements-dev.txt +4 -0
- torchlight_spark-0.1.0/scripts/check_distribution.py +115 -0
- torchlight_spark-0.1.0/setup.cfg +4 -0
- torchlight_spark-0.1.0/tests/test_torchlight.py +311 -0
- torchlight_spark-0.1.0/torchlight/__init__.py +4 -0
- torchlight_spark-0.1.0/torchlight/__main__.py +9 -0
- torchlight_spark-0.1.0/torchlight/analysis.py +33 -0
- torchlight_spark-0.1.0/torchlight/cli.py +67 -0
- torchlight_spark-0.1.0/torchlight/files.py +54 -0
- torchlight_spark-0.1.0/torchlight/notebooks.py +74 -0
- torchlight_spark-0.1.0/torchlight_spark.egg-info/PKG-INFO +90 -0
- torchlight_spark-0.1.0/torchlight_spark.egg-info/SOURCES.txt +23 -0
- torchlight_spark-0.1.0/torchlight_spark.egg-info/dependency_links.txt +1 -0
- torchlight_spark-0.1.0/torchlight_spark.egg-info/entry_points.txt +2 -0
- torchlight_spark-0.1.0/torchlight_spark.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 — 2026-10-18
|
|
4
|
+
|
|
5
|
+
- Initial PyPI release as `torchlight-spark`, with the `torchlight` command.
|
|
6
|
+
- Find `.collect()` and `.distinct()` calls in Python files and notebooks.
|
|
7
|
+
- Recursively scan directories while skipping common generated folders.
|
|
8
|
+
- Handle notebook magics, shell escapes, and top-level `await` without execution.
|
|
9
|
+
- Report findings and errors with file, cell, and line locations.
|
|
10
|
+
- No third-party runtime dependencies. Requires Python 3.12 or newer.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Use Python 3.12 or newer. Create a virtual environment, activate it, then install
|
|
4
|
+
the development tools:
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
python -m venv .venv
|
|
8
|
+
source .venv/bin/activate
|
|
9
|
+
python -m pip install -r requirements-dev.txt
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
On Windows, activate with `.venv\Scripts\Activate.ps1` in PowerShell instead.
|
|
13
|
+
|
|
14
|
+
## Making changes
|
|
15
|
+
|
|
16
|
+
1. Fork the repository if you do not have write access.
|
|
17
|
+
2. Create a branch, for example `git switch -c fix/notebook-parsing`.
|
|
18
|
+
3. Keep changes focused and add regression tests for behavior changes.
|
|
19
|
+
4. Run the same checks as CI:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
python -m ruff check .
|
|
23
|
+
python -m ruff format --check .
|
|
24
|
+
python -m unittest discover -s tests -v
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
To fix formatting, run `python -m ruff format .`.
|
|
28
|
+
|
|
29
|
+
5. Push your branch and open a pull request against `main`.
|
|
30
|
+
|
|
31
|
+
For packaging changes, also build and test both distributions:
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
python -m build
|
|
35
|
+
python -m twine check --strict dist/*
|
|
36
|
+
python scripts/check_distribution.py
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Start with an empty `dist/` directory so that old versions are not tested or
|
|
40
|
+
published accidentally. The verification script installs each archive in a
|
|
41
|
+
fresh virtual environment and checks metadata and license files, runs the test
|
|
42
|
+
suite against the installed package, and tests both CLI entry points outside
|
|
43
|
+
the source tree.
|
|
44
|
+
|
|
45
|
+
Do not commit credentials, private data, virtual environments, or notebook
|
|
46
|
+
outputs containing sensitive information. Report security issues privately as
|
|
47
|
+
described in [SECURITY.md](SECURITY.md).
|
|
48
|
+
|
|
49
|
+
## Main branch policy
|
|
50
|
+
|
|
51
|
+
All changes, including the owner's, must go through pull requests. CI and CodeQL
|
|
52
|
+
must pass against an up-to-date branch, and review conversations must be resolved.
|
|
53
|
+
High- and critical-severity CodeQL security findings block merging. Another
|
|
54
|
+
person's approval is welcome but is not required for this single-maintainer
|
|
55
|
+
project. Only squash merges are enabled.
|
|
56
|
+
|
|
57
|
+
Direct pushes, force-pushes, and deletion of `main` are blocked, with no bypass
|
|
58
|
+
actors. These protections are configured in GitHub; the intended rules are
|
|
59
|
+
recorded in [`.github/rulesets/main.json`](.github/rulesets/main.json). Editing
|
|
60
|
+
that file does not automatically change the live settings. Repository owners
|
|
61
|
+
can still edit the settings in GitHub.
|
|
62
|
+
|
|
63
|
+
GitHub Actions have read-only repository access by default. CodeQL has permission
|
|
64
|
+
to upload security results; only the publishing job can request a PyPI OIDC
|
|
65
|
+
identity token. Actions are pinned to commit SHAs;
|
|
66
|
+
Dependabot proposes updates to those pins and development dependencies. Updates
|
|
67
|
+
must pass the same checks and are not merged automatically.
|
|
68
|
+
|
|
69
|
+
## Publishing a release
|
|
70
|
+
|
|
71
|
+
The PyPI distribution is `torchlight-spark`; its CLI and import package remain
|
|
72
|
+
`torchlight`. Releases use GitHub Trusted Publishing, not stored API tokens.
|
|
73
|
+
|
|
74
|
+
One-time setup in PyPI's account publishing settings:
|
|
75
|
+
|
|
76
|
+
- Project: `torchlight-spark`
|
|
77
|
+
- GitHub owner/repository: `Kyle-j-bush/torchlight`
|
|
78
|
+
- Workflow: `publish.yml`
|
|
79
|
+
- Environment: `pypi`
|
|
80
|
+
|
|
81
|
+
The GitHub `pypi` environment permits only `v*` tags. Version tags cannot be
|
|
82
|
+
changed or deleted; the intended rules are in
|
|
83
|
+
[`.github/rulesets/releases.json`](.github/rulesets/releases.json). The repository
|
|
84
|
+
allows the official PyPA publishing action in addition to GitHub-owned actions,
|
|
85
|
+
and requires full commit-SHA pins for both.
|
|
86
|
+
|
|
87
|
+
For each release:
|
|
88
|
+
|
|
89
|
+
1. Update `project.version` in `pyproject.toml` and `CHANGELOG.md` through a PR.
|
|
90
|
+
2. Merge the PR and wait for CI and CodeQL to pass on `main`.
|
|
91
|
+
3. Tag that tested commit as `v<version>` and push the tag.
|
|
92
|
+
4. Publish a GitHub release for that tag. This starts `publish.yml`.
|
|
93
|
+
5. Verify the workflow and installation from PyPI before announcing the release.
|
|
94
|
+
|
|
95
|
+
The release workflow verifies that the tag matches the package version and is
|
|
96
|
+
on `main`'s history, rebuilds and tests both archives, then passes only those
|
|
97
|
+
artifacts to the isolated publishing job. It publishes provenance attestations
|
|
98
|
+
alongside the package. TestPyPI is not used.
|
|
99
|
+
|
|
100
|
+
PyPI versions and version tags are immutable: fix a bad release with a new
|
|
101
|
+
version rather than replacing existing files.
|
|
102
|
+
|
|
103
|
+
## License
|
|
104
|
+
|
|
105
|
+
Contributions are accepted under the [Apache License 2.0](LICENSE). Only submit
|
|
106
|
+
code you have the right to contribute, and preserve applicable notices.
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: torchlight-spark
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Scan Python files and Jupyter notebooks for Spark method calls.
|
|
5
|
+
Author: Kyle Bush
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/Kyle-j-bush/torchlight
|
|
8
|
+
Project-URL: Issues, https://github.com/Kyle-j-bush/torchlight/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/Kyle-j-bush/torchlight/blob/main/CHANGELOG.md
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
18
|
+
Requires-Python: >=3.12
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
License-File: NOTICE
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# Torchlight
|
|
25
|
+
|
|
26
|
+
[](https://github.com/Kyle-j-bush/torchlight/actions/workflows/ci.yml)
|
|
27
|
+
[](https://github.com/Kyle-j-bush/torchlight/actions/workflows/codeql.yml)
|
|
28
|
+
|
|
29
|
+
Find `.collect()` and `.distinct()` calls without running your code. Uses only
|
|
30
|
+
the Python standard library (Python 3.12+).
|
|
31
|
+
|
|
32
|
+
## Install and run
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
pip install torchlight-spark
|
|
36
|
+
torchlight path/to/file.py path/to/notebook.ipynb path/to/directory
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
For an isolated CLI installation, use `pipx install torchlight-spark` instead.
|
|
40
|
+
The distribution is named `torchlight-spark`, but the command and Python package
|
|
41
|
+
are named `torchlight`. Do not install it alongside the unrelated `torchlight`
|
|
42
|
+
PyPI distribution in the same environment.
|
|
43
|
+
|
|
44
|
+
You can also run directly from a checkout:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
python main.py path/to/file.py path/to/notebook.ipynb path/to/directory
|
|
48
|
+
# Or: python -m torchlight <paths...>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
- Directories are scanned recursively, skipping virtual environments, version
|
|
52
|
+
control folders, notebook checkpoints, `__pycache__`, and `node_modules`.
|
|
53
|
+
- Notebooks support top-level `await`, line magics, shell escapes, and Python
|
|
54
|
+
cell magics (`capture`, `debug`, `prun`, `time`, `timeit`). Other cell magics
|
|
55
|
+
are skipped. Cell numbers count code cells only.
|
|
56
|
+
- Detection is based on method names, not Spark type information.
|
|
57
|
+
|
|
58
|
+
Findings go to stdout; errors go to stderr:
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
pipeline.py:4: spark method .collect()
|
|
62
|
+
report.ipynb:cell 3,line 2: spark method .distinct()
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Exit codes: **0** = no findings or errors, **1** = findings (even with errors),
|
|
66
|
+
**2** = errors only.
|
|
67
|
+
|
|
68
|
+
Run the regression tests:
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
python -m unittest discover -s tests
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Development and security
|
|
75
|
+
|
|
76
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, linting, and the pull request
|
|
77
|
+
workflow. CI tests Python 3.12–3.14 on Linux and Python 3.12 on macOS and Windows.
|
|
78
|
+
It also builds and tests both the wheel and source distribution in clean environments.
|
|
79
|
+
The `main` branch requires passing CI and CodeQL checks through pull requests;
|
|
80
|
+
direct pushes and protection bypasses are disabled.
|
|
81
|
+
|
|
82
|
+
See [SECURITY.md](SECURITY.md) for safe-use guidance and private vulnerability
|
|
83
|
+
reporting. Never share credentials or private notebooks in issues.
|
|
84
|
+
|
|
85
|
+
Release notes are in [CHANGELOG.md](CHANGELOG.md).
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
Copyright 2026 Kyle Bush. Licensed under the [Apache License 2.0](LICENSE)
|
|
90
|
+
(`Apache-2.0`). See [NOTICE](NOTICE) for attribution.
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Torchlight
|
|
2
|
+
|
|
3
|
+
[](https://github.com/Kyle-j-bush/torchlight/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/Kyle-j-bush/torchlight/actions/workflows/codeql.yml)
|
|
5
|
+
|
|
6
|
+
Find `.collect()` and `.distinct()` calls without running your code. Uses only
|
|
7
|
+
the Python standard library (Python 3.12+).
|
|
8
|
+
|
|
9
|
+
## Install and run
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
pip install torchlight-spark
|
|
13
|
+
torchlight path/to/file.py path/to/notebook.ipynb path/to/directory
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
For an isolated CLI installation, use `pipx install torchlight-spark` instead.
|
|
17
|
+
The distribution is named `torchlight-spark`, but the command and Python package
|
|
18
|
+
are named `torchlight`. Do not install it alongside the unrelated `torchlight`
|
|
19
|
+
PyPI distribution in the same environment.
|
|
20
|
+
|
|
21
|
+
You can also run directly from a checkout:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
python main.py path/to/file.py path/to/notebook.ipynb path/to/directory
|
|
25
|
+
# Or: python -m torchlight <paths...>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
- Directories are scanned recursively, skipping virtual environments, version
|
|
29
|
+
control folders, notebook checkpoints, `__pycache__`, and `node_modules`.
|
|
30
|
+
- Notebooks support top-level `await`, line magics, shell escapes, and Python
|
|
31
|
+
cell magics (`capture`, `debug`, `prun`, `time`, `timeit`). Other cell magics
|
|
32
|
+
are skipped. Cell numbers count code cells only.
|
|
33
|
+
- Detection is based on method names, not Spark type information.
|
|
34
|
+
|
|
35
|
+
Findings go to stdout; errors go to stderr:
|
|
36
|
+
|
|
37
|
+
```text
|
|
38
|
+
pipeline.py:4: spark method .collect()
|
|
39
|
+
report.ipynb:cell 3,line 2: spark method .distinct()
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Exit codes: **0** = no findings or errors, **1** = findings (even with errors),
|
|
43
|
+
**2** = errors only.
|
|
44
|
+
|
|
45
|
+
Run the regression tests:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
python -m unittest discover -s tests
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Development and security
|
|
52
|
+
|
|
53
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, linting, and the pull request
|
|
54
|
+
workflow. CI tests Python 3.12–3.14 on Linux and Python 3.12 on macOS and Windows.
|
|
55
|
+
It also builds and tests both the wheel and source distribution in clean environments.
|
|
56
|
+
The `main` branch requires passing CI and CodeQL checks through pull requests;
|
|
57
|
+
direct pushes and protection bypasses are disabled.
|
|
58
|
+
|
|
59
|
+
See [SECURITY.md](SECURITY.md) for safe-use guidance and private vulnerability
|
|
60
|
+
reporting. Never share credentials or private notebooks in issues.
|
|
61
|
+
|
|
62
|
+
Release notes are in [CHANGELOG.md](CHANGELOG.md).
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
Copyright 2026 Kyle Bush. Licensed under the [Apache License 2.0](LICENSE)
|
|
67
|
+
(`Apache-2.0`). See [NOTICE](NOTICE) for attribution.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Security policy
|
|
2
|
+
|
|
3
|
+
Security fixes are provided on `main` and published in new releases. Use the
|
|
4
|
+
latest published version. Older releases do not receive backported fixes.
|
|
5
|
+
|
|
6
|
+
## Reporting a vulnerability
|
|
7
|
+
|
|
8
|
+
Please [report vulnerabilities privately through GitHub](https://github.com/Kyle-j-bush/torchlight/security/advisories/new),
|
|
9
|
+
not in a public issue. Include the affected commit, a minimal reproduction, and
|
|
10
|
+
the potential impact. Do not include real credentials or private datasets.
|
|
11
|
+
|
|
12
|
+
There is no guaranteed response time or paid support agreement.
|
|
13
|
+
|
|
14
|
+
## Safe use
|
|
15
|
+
|
|
16
|
+
Torchlight parses source files and notebooks; it never executes their code,
|
|
17
|
+
magics, or shell commands. It has no third-party runtime dependencies.
|
|
18
|
+
|
|
19
|
+
Parsing is not a sandbox. Very large or specially crafted inputs can exhaust
|
|
20
|
+
memory or CPU. When scanning untrusted files, use an isolated environment with
|
|
21
|
+
resource limits, without credentials or access to sensitive files.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77.0.3"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "torchlight-spark"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Scan Python files and Jupyter notebooks for Spark method calls."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.12"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
13
|
+
authors = [{ name = "Kyle Bush" }]
|
|
14
|
+
dependencies = []
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 3 - Alpha",
|
|
17
|
+
"Environment :: Console",
|
|
18
|
+
"Operating System :: OS Independent",
|
|
19
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
20
|
+
"Programming Language :: Python :: 3.12",
|
|
21
|
+
"Programming Language :: Python :: 3.13",
|
|
22
|
+
"Programming Language :: Python :: 3.14",
|
|
23
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
[project.scripts]
|
|
27
|
+
torchlight = "torchlight.cli:main"
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Repository = "https://github.com/Kyle-j-bush/torchlight"
|
|
31
|
+
Issues = "https://github.com/Kyle-j-bush/torchlight/issues"
|
|
32
|
+
Changelog = "https://github.com/Kyle-j-bush/torchlight/blob/main/CHANGELOG.md"
|
|
33
|
+
|
|
34
|
+
[tool.setuptools.packages.find]
|
|
35
|
+
include = ["torchlight", "torchlight.*"]
|
|
36
|
+
|
|
37
|
+
[tool.ruff]
|
|
38
|
+
target-version = "py312"
|
|
39
|
+
line-length = 88
|
|
40
|
+
|
|
41
|
+
[tool.ruff.lint]
|
|
42
|
+
select = ["E4", "E7", "E9", "F", "I", "UP", "B"]
|