fsweep 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.
@@ -0,0 +1 @@
1
+ * @drew-simmons
@@ -0,0 +1,57 @@
1
+ name: Bug report
2
+ description: Report a reproducible bug in fsweep
3
+ title: "[Bug]: "
4
+ labels: ["bug", "needs-triage"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for filing a bug. Please provide enough detail to reproduce.
10
+ - type: textarea
11
+ id: summary
12
+ attributes:
13
+ label: What happened?
14
+ description: Describe the current behavior and expected behavior.
15
+ placeholder: A clear and concise description of the bug.
16
+ validations:
17
+ required: true
18
+ - type: textarea
19
+ id: steps
20
+ attributes:
21
+ label: Steps to reproduce
22
+ description: Exact commands and context that trigger the bug.
23
+ placeholder: |
24
+ 1. Run `uv run fsweep --path ...`
25
+ 2. Use flags `...`
26
+ 3. Observe `...`
27
+ validations:
28
+ required: true
29
+ - type: textarea
30
+ id: logs
31
+ attributes:
32
+ label: Relevant output
33
+ description: Paste terminal output, stack traces, or screenshots.
34
+ render: shell
35
+ validations:
36
+ required: false
37
+ - type: input
38
+ id: version
39
+ attributes:
40
+ label: fsweep version
41
+ placeholder: 0.1.0
42
+ validations:
43
+ required: true
44
+ - type: input
45
+ id: platform
46
+ attributes:
47
+ label: OS / environment
48
+ placeholder: macOS 15.3, Ubuntu 24.04, etc.
49
+ validations:
50
+ required: true
51
+ - type: checkboxes
52
+ id: checks
53
+ attributes:
54
+ label: Pre-flight checks
55
+ options:
56
+ - label: I searched existing issues
57
+ required: true
@@ -0,0 +1,8 @@
1
+ blank_issues_enabled: false
2
+ contact_links:
3
+ - name: Security vulnerability report
4
+ url: https://github.com/drew-simmons/fsweep/security/advisories/new
5
+ about: Report vulnerabilities privately through GitHub Security Advisories.
6
+ - name: Usage questions and support
7
+ url: https://github.com/drew-simmons/fsweep/blob/main/SUPPORT.md
8
+ about: Read support guidance before opening a bug or feature issue.
@@ -0,0 +1,39 @@
1
+ name: Feature request
2
+ description: Suggest an improvement to fsweep
3
+ title: "[Feature]: "
4
+ labels: ["enhancement", "needs-triage"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for the idea. Please describe the problem first, then the proposed change.
10
+ - type: textarea
11
+ id: problem
12
+ attributes:
13
+ label: Problem to solve
14
+ description: What workflow is painful today?
15
+ placeholder: I want to be able to...
16
+ validations:
17
+ required: true
18
+ - type: textarea
19
+ id: proposal
20
+ attributes:
21
+ label: Proposed solution
22
+ description: Describe the behavior you'd like.
23
+ placeholder: fsweep should...
24
+ validations:
25
+ required: true
26
+ - type: textarea
27
+ id: alternatives
28
+ attributes:
29
+ label: Alternatives considered
30
+ description: Any other approaches or workarounds?
31
+ validations:
32
+ required: false
33
+ - type: textarea
34
+ id: context
35
+ attributes:
36
+ label: Additional context
37
+ description: Include examples, references, or mock outputs.
38
+ validations:
39
+ required: false
@@ -0,0 +1,23 @@
1
+ ## Summary
2
+
3
+ <!-- What changed and why? -->
4
+
5
+ ## Changes
6
+
7
+ -
8
+
9
+ ## Validation
10
+
11
+ <!-- Commands you ran, with relevant output -->
12
+
13
+ ```bash
14
+ uv run pytest
15
+ uv run ruff check .
16
+ uv run ty check .
17
+ ```
18
+
19
+ ## Checklist
20
+
21
+ - [ ] I ran tests or explain why not
22
+ - [ ] I added or updated docs when behavior changed
23
+ - [ ] I confirmed this does not introduce unrelated changes
@@ -0,0 +1,48 @@
1
+ name: ci
2
+
3
+ on:
4
+ pull_request:
5
+ types:
6
+ - opened
7
+ - synchronize
8
+ - reopened
9
+ push:
10
+ branches:
11
+ - main
12
+
13
+ jobs:
14
+ prek:
15
+ name: run pre-commits
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - uses: actions/checkout@v6
19
+ - uses: j178/prek-action@v1
20
+
21
+ test:
22
+ name: run tests
23
+ runs-on: ubuntu-latest
24
+ steps:
25
+ - uses: actions/checkout@v4
26
+ - uses: astral-sh/setup-uv@v3
27
+ - run: uv run pytest
28
+
29
+ lint:
30
+ name: lint and type check
31
+ runs-on: ubuntu-latest
32
+ steps:
33
+ - uses: actions/checkout@v4
34
+ - uses: astral-sh/setup-uv@v3
35
+ - run: uv run ruff check .
36
+ - run: uv run ty check .
37
+
38
+ packaging:
39
+ name: packaging smoke tests
40
+ runs-on: ubuntu-latest
41
+ steps:
42
+ - uses: actions/checkout@v4
43
+ - uses: astral-sh/setup-uv@v3
44
+ - run: uv build
45
+ - run: uv run --isolated --no-project --with dist/*.whl fsweep --help
46
+ - run: uv run --isolated --no-project --with dist/*.whl python -m fsweep --help
47
+ - run: uv run --isolated --no-project --with dist/*.tar.gz fsweep --help
48
+ - run: uv run --isolated --no-project --with dist/*.tar.gz python -m fsweep --help
@@ -0,0 +1,40 @@
1
+ name: publish
2
+
3
+ on:
4
+ workflow_run:
5
+ workflows:
6
+ - release
7
+ types:
8
+ - completed
9
+ branches:
10
+ - main
11
+
12
+ jobs:
13
+ publish:
14
+ name: publish to pypi
15
+ if: github.event.workflow_run.conclusion == 'success'
16
+ runs-on: ubuntu-latest
17
+ environment:
18
+ name: pypi
19
+ permissions:
20
+ id-token: write
21
+ contents: read
22
+ steps:
23
+ - name: checkout
24
+ uses: actions/checkout@v5
25
+ - name: install uv
26
+ uses: astral-sh/setup-uv@v6
27
+ - name: install python
28
+ run: uv python install 3.13
29
+ - name: build
30
+ run: uv build
31
+ - name: smoke test (wheel, cli)
32
+ run: uv run --isolated --no-project --with dist/*.whl fsweep --help
33
+ - name: smoke test (wheel, module)
34
+ run: uv run --isolated --no-project --with dist/*.whl python -m fsweep --help
35
+ - name: smoke test (sdist, cli)
36
+ run: uv run --isolated --no-project --with dist/*.tar.gz fsweep --help
37
+ - name: smoke test (sdist, module)
38
+ run: uv run --isolated --no-project --with dist/*.tar.gz python -m fsweep --help
39
+ - name: publish
40
+ run: uv publish
@@ -0,0 +1,84 @@
1
+ name: release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ jobs:
9
+ release:
10
+ name: update changelog and create release
11
+ runs-on: ubuntu-latest
12
+ if: github.actor != 'github-actions[bot]'
13
+ permissions:
14
+ contents: write
15
+ pull-requests: read
16
+ steps:
17
+ - name: checkout
18
+ uses: actions/checkout@v5
19
+ with:
20
+ fetch-depth: 0
21
+
22
+ - name: resolve release tag
23
+ id: version
24
+ run: |
25
+ version="$(sed -n 's/^version = "\(.*\)"/\1/p' pyproject.toml | head -n 1)"
26
+ tag="v${version}"
27
+ if git rev-parse "${tag}" >/dev/null 2>&1; then
28
+ should_release=false
29
+ else
30
+ should_release=true
31
+ fi
32
+ echo "tag=${tag}" >> "${GITHUB_OUTPUT}"
33
+ echo "should_release=${should_release}" >> "${GITHUB_OUTPUT}"
34
+
35
+ - name: generate changelog
36
+ if: steps.version.outputs.should_release == 'true'
37
+ uses: orhun/git-cliff-action@v4
38
+ with:
39
+ config: pyproject.toml
40
+ args: --tag ${{ steps.version.outputs.tag }}
41
+ env:
42
+ OUTPUT: CHANGELOG.md
43
+ GITHUB_REPO: ${{ github.repository }}
44
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45
+
46
+ - name: commit changelog
47
+ if: steps.version.outputs.should_release == 'true'
48
+ run: |
49
+ git config user.name "github-actions[bot]"
50
+ git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
51
+ git add CHANGELOG.md
52
+ if git diff --cached --quiet; then
53
+ exit 0
54
+ fi
55
+ git commit -m "chore(release): update changelog for ${{ steps.version.outputs.tag }}"
56
+ git push origin HEAD:main
57
+
58
+ - name: create and push tag
59
+ if: steps.version.outputs.should_release == 'true'
60
+ run: |
61
+ git tag "${{ steps.version.outputs.tag }}"
62
+ git push origin "${{ steps.version.outputs.tag }}"
63
+
64
+ - name: generate release notes
65
+ if: steps.version.outputs.should_release == 'true'
66
+ id: release_notes
67
+ uses: orhun/git-cliff-action@v4
68
+ with:
69
+ config: pyproject.toml
70
+ args: --tag ${{ steps.version.outputs.tag }} --strip header
71
+ env:
72
+ GITHUB_REPO: ${{ github.repository }}
73
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
74
+
75
+ - name: create github release
76
+ if: steps.version.outputs.should_release == 'true'
77
+ uses: softprops/action-gh-release@v2
78
+ with:
79
+ tag_name: ${{ steps.version.outputs.tag }}
80
+ body: ${{ steps.release_notes.outputs.content }}
81
+
82
+ - name: no-op when tag exists
83
+ if: steps.version.outputs.should_release != 'true'
84
+ run: echo "Tag ${{ steps.version.outputs.tag }} already exists; skipping release."
@@ -0,0 +1,195 @@
1
+ # Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
2
+ # Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode
3
+
4
+ ### Python ###
5
+ # Byte-compiled / optimized / DLL files
6
+ __pycache__/
7
+ *.py[cod]
8
+ *$py.class
9
+
10
+ # C extensions
11
+ *.so
12
+
13
+ # Distribution / packaging
14
+ .Python
15
+ build/
16
+ develop-eggs/
17
+ dist/
18
+ downloads/
19
+ eggs/
20
+ .eggs/
21
+ lib/
22
+ lib64/
23
+ parts/
24
+ sdist/
25
+ var/
26
+ wheels/
27
+ share/python-wheels/
28
+ *.egg-info/
29
+ .installed.cfg
30
+ *.egg
31
+ MANIFEST
32
+
33
+ # PyInstaller
34
+ # Usually these files are written by a python script from a template
35
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
36
+ *.manifest
37
+ *.spec
38
+
39
+ # Installer logs
40
+ pip-log.txt
41
+ pip-delete-this-directory.txt
42
+
43
+ # Unit test / coverage reports
44
+ htmlcov/
45
+ .tox/
46
+ .nox/
47
+ .coverage
48
+ .coverage.*
49
+ .cache
50
+ nosetests.xml
51
+ coverage.xml
52
+ *.cover
53
+ *.py,cover
54
+ .hypothesis/
55
+ .pytest_cache/
56
+ cover/
57
+
58
+ # Translations
59
+ *.mo
60
+ *.pot
61
+
62
+ # Django stuff:
63
+ *.log
64
+ local_settings.py
65
+ db.sqlite3
66
+ db.sqlite3-journal
67
+
68
+ # Flask stuff:
69
+ instance/
70
+ .webassets-cache
71
+
72
+ # Scrapy stuff:
73
+ .scrapy
74
+
75
+ # Sphinx documentation
76
+ docs/_build/
77
+
78
+ # PyBuilder
79
+ .pybuilder/
80
+ target/
81
+
82
+ # Jupyter Notebook
83
+ .ipynb_checkpoints
84
+
85
+ # IPython
86
+ profile_default/
87
+ ipython_config.py
88
+
89
+ # pyenv
90
+ # For a library or package, you might want to ignore these files since the code is
91
+ # intended to run in multiple environments; otherwise, check them in:
92
+ # .python-version
93
+
94
+ # pipenv
95
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
97
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
98
+ # install all needed dependencies.
99
+ #Pipfile.lock
100
+
101
+ # poetry
102
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
103
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
104
+ # commonly ignored for libraries.
105
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
106
+ #poetry.lock
107
+
108
+ # pdm
109
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
110
+ #pdm.lock
111
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
112
+ # in version control.
113
+ # https://pdm.fming.dev/#use-with-ide
114
+ .pdm.toml
115
+
116
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
117
+ __pypackages__/
118
+
119
+ # Celery stuff
120
+ celerybeat-schedule
121
+ celerybeat.pid
122
+
123
+ # SageMath parsed files
124
+ *.sage.py
125
+
126
+ # Environments
127
+ .env
128
+ .venv
129
+ env/
130
+ venv/
131
+ ENV/
132
+ env.bak/
133
+ venv.bak/
134
+
135
+ # Spyder project settings
136
+ .spyderproject
137
+ .spyproject
138
+
139
+ # Rope project settings
140
+ .ropeproject
141
+
142
+ # mkdocs documentation
143
+ /site
144
+
145
+ # mypy
146
+ .mypy_cache/
147
+ .dmypy.json
148
+ dmypy.json
149
+
150
+ # Pyre type checker
151
+ .pyre/
152
+
153
+ # pytype static type analyzer
154
+ .pytype/
155
+
156
+ # Cython debug symbols
157
+ cython_debug/
158
+
159
+ # PyCharm
160
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
161
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
162
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
163
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
164
+ #.idea/
165
+
166
+ ### Python Patch ###
167
+ # Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
168
+ poetry.toml
169
+
170
+ # ruff
171
+ .ruff_cache/
172
+
173
+ # LSP config files
174
+ pyrightconfig.json
175
+
176
+ ### VisualStudioCode ###
177
+ .vscode/*
178
+ !.vscode/settings.json
179
+ !.vscode/tasks.json
180
+ !.vscode/launch.json
181
+ !.vscode/extensions.json
182
+ !.vscode/*.code-snippets
183
+
184
+ # Local History for Visual Studio Code
185
+ .history/
186
+
187
+ # Built Visual Studio Code Extensions
188
+ *.vsix
189
+
190
+ ### VisualStudioCode Patch ###
191
+ # Ignore all local history of files
192
+ .history
193
+ .ionide
194
+
195
+ # End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
@@ -0,0 +1 @@
1
+ 3.13
@@ -0,0 +1,46 @@
1
+ ## [0.1.0] - 2026-02-24
2
+
3
+ ### ๐Ÿš€ Features
4
+
5
+ - Initial commit
6
+ - Expand fsweep targets and update tooling
7
+
8
+ ### ๐Ÿ› Bug Fixes
9
+
10
+ - *(ci)* Run prek
11
+ - *(prek)* Ty args
12
+ - When actions run
13
+ - *(release)* Grant read access to pull requests for git-cliff
14
+
15
+ ### ๐Ÿ’ผ Other
16
+
17
+ - *(deps)* Remove pytest-cov from dev dependencies
18
+
19
+ ### ๐Ÿ“š Documentation
20
+
21
+ - *(readme)* Refresh install and development instructions
22
+ - *(repo)* Scaffold templates and community files
23
+
24
+ ### โšก Performance
25
+
26
+ - *(cli)* Avoid redundant traversal when scanning targets
27
+
28
+ ### ๐ŸŽจ Styling
29
+
30
+ - *(tests)* Normalize imports and docstring formatting
31
+ - Satisfy ruff checks in fsweep package modules
32
+
33
+ ### ๐Ÿงช Testing
34
+
35
+ - Fix ruff violations across test suite
36
+
37
+ ### โš™๏ธ Miscellaneous Tasks
38
+
39
+ - *(tooling)* Configure ruff, ty, and local ty pre-commit hook
40
+ - *(workflows)* Add pytest job and PyPI release pipeline
41
+ - *(tooling)* Configure ruff, ty, and local ty pre-commit hook
42
+ - *(tests)* Format for extra line
43
+ - Remove ty prek
44
+ - *(repo)* Apply prek formatting updates
45
+ - *(ci)* Split release and publish workflows
46
+ - Update project metadata and lockfile
@@ -0,0 +1,34 @@
1
+ # Contributing
2
+
3
+ Thanks for contributing to `fsweep`.
4
+
5
+ ## Development setup
6
+
7
+ ```bash
8
+ uv sync
9
+ ```
10
+
11
+ ## Run checks locally
12
+
13
+ ```bash
14
+ uv run pytest
15
+ uv run ruff check .
16
+ uv run ty check .
17
+ ```
18
+
19
+ Optional full pre-commit run:
20
+
21
+ ```bash
22
+ uv run prek -a
23
+ ```
24
+
25
+ ## Pull request expectations
26
+
27
+ - Keep changes focused and scoped.
28
+ - Include tests for behavior changes when possible.
29
+ - Update `README.md` and `CHANGELOG.md` if user-visible behavior changes.
30
+ - Use clear PR descriptions and include verification steps.
31
+
32
+ ## Release notes
33
+
34
+ - Add notable user-facing changes to the `Unreleased` section in `CHANGELOG.md`.
fsweep-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Drew Simmons
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.