foldermix 0.1.1__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.
Files changed (74) hide show
  1. foldermix-0.1.1/.github/dependabot.yml +21 -0
  2. foldermix-0.1.1/.github/workflows/ci.yml +214 -0
  3. foldermix-0.1.1/.github/workflows/mutation.yml +34 -0
  4. foldermix-0.1.1/.github/workflows/perf-smoke.yml +29 -0
  5. foldermix-0.1.1/.github/workflows/security-audit.yml +32 -0
  6. foldermix-0.1.1/.gitignore +208 -0
  7. foldermix-0.1.1/.pre-commit-config.yaml +49 -0
  8. foldermix-0.1.1/.python-version +1 -0
  9. foldermix-0.1.1/CONTRIBUTING.md +38 -0
  10. foldermix-0.1.1/LICENSE +21 -0
  11. foldermix-0.1.1/PKG-INFO +149 -0
  12. foldermix-0.1.1/README.md +94 -0
  13. foldermix-0.1.1/SECURITY.md +20 -0
  14. foldermix-0.1.1/foldermix/__init__.py +3 -0
  15. foldermix-0.1.1/foldermix/cli.py +176 -0
  16. foldermix-0.1.1/foldermix/config.py +141 -0
  17. foldermix-0.1.1/foldermix/converters/__init__.py +1 -0
  18. foldermix-0.1.1/foldermix/converters/base.py +33 -0
  19. foldermix-0.1.1/foldermix/converters/docx_fallback.py +26 -0
  20. foldermix-0.1.1/foldermix/converters/markitdown_conv.py +28 -0
  21. foldermix-0.1.1/foldermix/converters/pdf_fallback.py +29 -0
  22. foldermix-0.1.1/foldermix/converters/pptx_fallback.py +32 -0
  23. foldermix-0.1.1/foldermix/converters/text.py +85 -0
  24. foldermix-0.1.1/foldermix/converters/xlsx_fallback.py +34 -0
  25. foldermix-0.1.1/foldermix/packer.py +249 -0
  26. foldermix-0.1.1/foldermix/report.py +19 -0
  27. foldermix-0.1.1/foldermix/scanner.py +160 -0
  28. foldermix-0.1.1/foldermix/utils.py +80 -0
  29. foldermix-0.1.1/foldermix/writers/__init__.py +1 -0
  30. foldermix-0.1.1/foldermix/writers/base.py +33 -0
  31. foldermix-0.1.1/foldermix/writers/jsonl_writer.py +36 -0
  32. foldermix-0.1.1/foldermix/writers/markdown_writer.py +101 -0
  33. foldermix-0.1.1/foldermix/writers/xml_writer.py +37 -0
  34. foldermix-0.1.1/pyproject.toml +69 -0
  35. foldermix-0.1.1/tests/__init__.py +0 -0
  36. foldermix-0.1.1/tests/conftest.py +48 -0
  37. foldermix-0.1.1/tests/data/excluded_dir/ignored.txt +1 -0
  38. foldermix-0.1.1/tests/data/nested/child.txt +1 -0
  39. foldermix-0.1.1/tests/data/sample.csv +2 -0
  40. foldermix-0.1.1/tests/data/sample.json +1 -0
  41. foldermix-0.1.1/tests/data/sample.md +3 -0
  42. foldermix-0.1.1/tests/data/sample.txt +1 -0
  43. foldermix-0.1.1/tests/integration/fixtures/expected/real_files/sample_docx.txt +3 -0
  44. foldermix-0.1.1/tests/integration/fixtures/expected/real_files/sample_pdf.txt +1 -0
  45. foldermix-0.1.1/tests/integration/fixtures/expected/real_files/sample_pptx.txt +4 -0
  46. foldermix-0.1.1/tests/integration/fixtures/expected/real_files/sample_xlsx.txt +5 -0
  47. foldermix-0.1.1/tests/integration/fixtures/expected/simple_project.jsonl +4 -0
  48. foldermix-0.1.1/tests/integration/fixtures/expected/simple_project.md +49 -0
  49. foldermix-0.1.1/tests/integration/fixtures/expected/simple_project.xml +37 -0
  50. foldermix-0.1.1/tests/integration/fixtures/real_files/sample.docx +0 -0
  51. foldermix-0.1.1/tests/integration/fixtures/real_files/sample.pdf +45 -0
  52. foldermix-0.1.1/tests/integration/fixtures/real_files/sample.pptx +0 -0
  53. foldermix-0.1.1/tests/integration/fixtures/real_files/sample.xlsx +0 -0
  54. foldermix-0.1.1/tests/integration/fixtures/simple_project/alpha.md +1 -0
  55. foldermix-0.1.1/tests/integration/fixtures/simple_project/code.py +1 -0
  56. foldermix-0.1.1/tests/integration/fixtures/simple_project/nested/note.txt +2 -0
  57. foldermix-0.1.1/tests/integration/test_converters_real_files.py +97 -0
  58. foldermix-0.1.1/tests/integration/test_pack_outputs.py +18 -0
  59. foldermix-0.1.1/tests/integration/test_pack_outputs_structured.py +25 -0
  60. foldermix-0.1.1/tests/snapshot_helpers.py +67 -0
  61. foldermix-0.1.1/tests/test_cli.py +104 -0
  62. foldermix-0.1.1/tests/test_cli_entrypoint.py +26 -0
  63. foldermix-0.1.1/tests/test_converters.py +138 -0
  64. foldermix-0.1.1/tests/test_converters_fallback.py +137 -0
  65. foldermix-0.1.1/tests/test_packer.py +185 -0
  66. foldermix-0.1.1/tests/test_packer_edges.py +148 -0
  67. foldermix-0.1.1/tests/test_perf_smoke.py +68 -0
  68. foldermix-0.1.1/tests/test_scanner.py +134 -0
  69. foldermix-0.1.1/tests/test_scanner_edge.py +48 -0
  70. foldermix-0.1.1/tests/test_scanner_properties.py +128 -0
  71. foldermix-0.1.1/tests/test_snapshot_guard.py +28 -0
  72. foldermix-0.1.1/tests/test_utils.py +115 -0
  73. foldermix-0.1.1/tests/test_writers.py +199 -0
  74. foldermix-0.1.1/tests/test_writers_edge.py +83 -0
@@ -0,0 +1,21 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "pip"
4
+ directory: "/"
5
+ schedule:
6
+ interval: "weekly"
7
+ labels:
8
+ - "dependencies"
9
+ - "python"
10
+ commit-message:
11
+ prefix: "deps"
12
+
13
+ - package-ecosystem: "github-actions"
14
+ directory: "/"
15
+ schedule:
16
+ interval: "weekly"
17
+ labels:
18
+ - "dependencies"
19
+ - "ci"
20
+ commit-message:
21
+ prefix: "ci"
@@ -0,0 +1,214 @@
1
+ name: CI
2
+ on:
3
+ push:
4
+ branches: [main]
5
+ tags: ["v*"]
6
+ pull_request:
7
+
8
+ jobs:
9
+ lint:
10
+ runs-on: ubuntu-latest
11
+ permissions:
12
+ contents: read
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+ - uses: actions/setup-python@v6
16
+ with:
17
+ python-version: "3.12"
18
+ - name: Install dependencies
19
+ run: pip install -e ".[dev,all]"
20
+ - name: Lint
21
+ run: ruff check . && ruff format --check .
22
+
23
+ smoke:
24
+ runs-on: ${{ matrix.os }}
25
+ permissions:
26
+ contents: read
27
+ strategy:
28
+ fail-fast: false
29
+ matrix:
30
+ include:
31
+ - os: ubuntu-latest
32
+ python-version: "3.10"
33
+ - os: ubuntu-latest
34
+ python-version: "3.11"
35
+ - os: ubuntu-latest
36
+ python-version: "3.12"
37
+ - os: macos-latest
38
+ python-version: "3.12"
39
+ - os: windows-latest
40
+ python-version: "3.12"
41
+ steps:
42
+ - uses: actions/checkout@v4
43
+ - uses: actions/setup-python@v6
44
+ with:
45
+ python-version: ${{ matrix.python-version }}
46
+ - name: Install dependencies
47
+ run: pip install -e ".[dev,all]"
48
+ - name: Unit Smoke Tests (No Integration/Slow)
49
+ run: python -m pytest -m "not integration and not slow" -o addopts="-vv -ra --strict-markers --strict-config"
50
+
51
+ minimal-deps:
52
+ runs-on: ubuntu-latest
53
+ permissions:
54
+ contents: read
55
+ steps:
56
+ - uses: actions/checkout@v4
57
+ - uses: actions/setup-python@v6
58
+ with:
59
+ python-version: "3.12"
60
+ - name: Install core + dev dependencies (no optional extras)
61
+ run: pip install -e ".[dev]"
62
+ - name: Core Behavior Tests (No Integration/Slow)
63
+ run: >
64
+ python -m pytest
65
+ tests/test_cli.py
66
+ tests/test_converters.py
67
+ tests/test_converters_fallback.py
68
+ tests/test_packer.py
69
+ tests/test_packer_edges.py
70
+ tests/test_scanner.py
71
+ tests/test_scanner_edge.py
72
+ tests/test_snapshot_guard.py
73
+ tests/test_utils.py
74
+ tests/test_writers.py
75
+ tests/test_writers_edge.py
76
+ -m "not integration and not slow"
77
+ -o addopts="-vv -ra --strict-markers --strict-config"
78
+
79
+ package-smoke:
80
+ runs-on: ubuntu-latest
81
+ permissions:
82
+ contents: read
83
+ steps:
84
+ - uses: actions/checkout@v4
85
+ - uses: actions/setup-python@v6
86
+ with:
87
+ python-version: "3.12"
88
+ - name: Build wheel
89
+ run: |
90
+ python -m pip install --upgrade pip build
91
+ python -m build
92
+ - name: Install wheel in clean venv and run CLI black-box assertions
93
+ run: |
94
+ set -euo pipefail
95
+ python -m venv .pkg-smoke-venv
96
+ ./.pkg-smoke-venv/bin/pip install dist/*.whl
97
+
98
+ assert_contains() {
99
+ haystack="$1"
100
+ needle="$2"
101
+ if ! printf "%s" "$haystack" | grep -Fq "$needle"; then
102
+ echo "Expected output to contain: $needle"
103
+ echo "Actual output:"
104
+ printf "%s\n" "$haystack"
105
+ exit 1
106
+ fi
107
+ }
108
+
109
+ run_expect() {
110
+ expected="$1"
111
+ shift
112
+ set +e
113
+ output="$("$@" 2>&1)"
114
+ status=$?
115
+ set -e
116
+ if [ "$status" -ne "$expected" ]; then
117
+ echo "Expected exit code $expected, got $status"
118
+ echo "Command: $*"
119
+ echo "Output:"
120
+ printf "%s\n" "$output"
121
+ exit 1
122
+ fi
123
+ printf "%s" "$output"
124
+ }
125
+
126
+ export NO_COLOR=1
127
+
128
+ mkdir -p smoke_input
129
+ printf "hello\n" > smoke_input/a.txt
130
+
131
+ version_out="$(run_expect 0 ./.pkg-smoke-venv/bin/foldermix version)"
132
+ assert_contains "$version_out" "foldermix "
133
+
134
+ list_out="$(run_expect 0 ./.pkg-smoke-venv/bin/foldermix list smoke_input)"
135
+ assert_contains "$list_out" "a.txt"
136
+ assert_contains "$list_out" "1 files would be included, 0 skipped."
137
+
138
+ stats_out="$(run_expect 0 ./.pkg-smoke-venv/bin/foldermix stats smoke_input)"
139
+ assert_contains "$stats_out" "Included files: 1"
140
+ assert_contains "$stats_out" ".txt"
141
+
142
+ pack_out="$(run_expect 0 ./.pkg-smoke-venv/bin/foldermix pack smoke_input --out smoke_output.md)"
143
+ assert_contains "$pack_out" "Done!"
144
+ assert_contains "$pack_out" "smoke_output.md"
145
+ test -f smoke_output.md
146
+
147
+ invalid_pack_out="$(run_expect 1 ./.pkg-smoke-venv/bin/foldermix pack smoke_input --format bad)"
148
+ assert_contains "$invalid_pack_out" "Invalid format"
149
+
150
+ invalid_list_out="$(run_expect 2 ./.pkg-smoke-venv/bin/foldermix list smoke_input --bad-flag)"
151
+ assert_contains "$invalid_list_out" "No such option"
152
+
153
+ invalid_stats_out="$(run_expect 2 ./.pkg-smoke-venv/bin/foldermix stats smoke_input --bad-flag)"
154
+ assert_contains "$invalid_stats_out" "No such option"
155
+
156
+ full:
157
+ runs-on: ubuntu-latest
158
+ needs: [lint, smoke, minimal-deps, package-smoke]
159
+ permissions:
160
+ contents: read
161
+ id-token: write
162
+ steps:
163
+ - uses: actions/checkout@v4
164
+ - uses: actions/setup-python@v6
165
+ with:
166
+ python-version: "3.12"
167
+ - name: Install dependencies
168
+ run: pip install -e ".[dev,all]"
169
+ - name: Full Test Suite (Coverage Gate)
170
+ run: python -m pytest --cov-report=xml
171
+ - name: Upload coverage to Codecov
172
+ uses: codecov/codecov-action@v5
173
+ with:
174
+ files: ./coverage.xml
175
+ fail_ci_if_error: true
176
+ token: ${{ secrets.CODECOV_TOKEN }}
177
+
178
+ publish-pypi:
179
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
180
+ runs-on: ubuntu-latest
181
+ needs: [full]
182
+ permissions:
183
+ contents: read
184
+ id-token: write
185
+ environment:
186
+ name: pypi
187
+ url: https://pypi.org/project/foldermix/
188
+ steps:
189
+ - uses: actions/checkout@v4
190
+ - uses: actions/setup-python@v6
191
+ with:
192
+ python-version: "3.12"
193
+ - name: Verify tag matches package version
194
+ run: |
195
+ python - <<'PY'
196
+ import os
197
+ import pathlib
198
+ import tomllib
199
+
200
+ version = tomllib.loads(pathlib.Path("pyproject.toml").read_text(encoding="utf-8"))["project"]["version"]
201
+ tag = os.environ["GITHUB_REF_NAME"]
202
+ expected = f"v{version}"
203
+ if tag != expected:
204
+ raise SystemExit(
205
+ f"Tag {tag} does not match project version {version} (expected {expected})"
206
+ )
207
+ print(f"Tag/version check passed: {tag}")
208
+ PY
209
+ - name: Build package
210
+ run: |
211
+ python -m pip install --upgrade pip build
212
+ python -m build
213
+ - name: Publish to PyPI
214
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,34 @@
1
+ name: Mutation Testing
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ schedule:
6
+ - cron: "0 9 * * 6" # Weekly on Saturday at 09:00 UTC
7
+
8
+ jobs:
9
+ mutmut:
10
+ runs-on: ubuntu-latest
11
+ timeout-minutes: 60
12
+ permissions:
13
+ contents: read
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: actions/setup-python@v5
17
+ with:
18
+ python-version: "3.12"
19
+ - name: Install dependencies
20
+ run: |
21
+ python -m pip install --upgrade pip
22
+ python -m pip install -e ".[dev,mutation,all]"
23
+ - name: Run mutation tests
24
+ run: python -m mutmut run
25
+ - name: Show surviving mutants
26
+ if: always()
27
+ run: python -m mutmut results
28
+ - name: Upload mutmut cache
29
+ if: always()
30
+ uses: actions/upload-artifact@v4
31
+ with:
32
+ name: mutmut-cache
33
+ path: .mutmut-cache
34
+ if-no-files-found: ignore
@@ -0,0 +1,29 @@
1
+ name: Performance Smoke
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ schedule:
6
+ - cron: "0 9 * * 0" # Weekly on Sunday at 09:00 UTC
7
+
8
+ jobs:
9
+ perf-smoke:
10
+ runs-on: ubuntu-latest
11
+ timeout-minutes: 30
12
+ permissions:
13
+ contents: read
14
+ env:
15
+ FOLDERMIX_RUN_PERF_SMOKE: "1"
16
+ FOLDERMIX_PERF_FILE_COUNT: "1500"
17
+ FOLDERMIX_PERF_MAX_SECONDS: "25"
18
+ FOLDERMIX_PERF_MAX_PEAK_MB: "256"
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+ - uses: actions/setup-python@v5
22
+ with:
23
+ python-version: "3.12"
24
+ - name: Install dependencies
25
+ run: |
26
+ python -m pip install --upgrade pip
27
+ python -m pip install -e ".[dev,all]"
28
+ - name: Run perf smoke test
29
+ run: python -m pytest tests/test_perf_smoke.py -q -o addopts=
@@ -0,0 +1,32 @@
1
+ name: Security Audit
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ schedule:
6
+ - cron: "0 9 * * 1" # Weekly on Monday at 09:00 UTC
7
+ push:
8
+ branches: [main]
9
+ paths:
10
+ - "pyproject.toml"
11
+ - ".github/workflows/security-audit.yml"
12
+ pull_request:
13
+ paths:
14
+ - "pyproject.toml"
15
+ - ".github/workflows/security-audit.yml"
16
+
17
+ jobs:
18
+ pip-audit:
19
+ runs-on: ubuntu-latest
20
+ permissions:
21
+ contents: read
22
+ steps:
23
+ - uses: actions/checkout@v4
24
+ - uses: actions/setup-python@v6
25
+ with:
26
+ python-version: "3.12"
27
+ - name: Install package and audit tool
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ python -m pip install -e ".[dev,all]" pip-audit
31
+ - name: Run pip-audit
32
+ run: pip-audit --progress-spinner off
@@ -0,0 +1,208 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ .mutmut-cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # UV
99
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ #uv.lock
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ #poetry.lock
110
+ #poetry.toml
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
115
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
116
+ #pdm.lock
117
+ #pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # pixi
122
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
123
+ #pixi.lock
124
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
125
+ # in the .venv directory. It is recommended not to include this directory in version control.
126
+ .pixi
127
+
128
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
129
+ __pypackages__/
130
+
131
+ # Celery stuff
132
+ celerybeat-schedule
133
+ celerybeat.pid
134
+
135
+ # SageMath parsed files
136
+ *.sage.py
137
+
138
+ # Environments
139
+ .env
140
+ .envrc
141
+ .venv
142
+ env/
143
+ venv/
144
+ ENV/
145
+ env.bak/
146
+ venv.bak/
147
+
148
+ # Spyder project settings
149
+ .spyderproject
150
+ .spyproject
151
+
152
+ # Rope project settings
153
+ .ropeproject
154
+
155
+ # mkdocs documentation
156
+ /site
157
+
158
+ # mypy
159
+ .mypy_cache/
160
+ .dmypy.json
161
+ dmypy.json
162
+
163
+ # Pyre type checker
164
+ .pyre/
165
+
166
+ # pytype static type analyzer
167
+ .pytype/
168
+
169
+ # Cython debug symbols
170
+ cython_debug/
171
+
172
+ # PyCharm
173
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
174
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
175
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
176
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
177
+ #.idea/
178
+
179
+ # Abstra
180
+ # Abstra is an AI-powered process automation framework.
181
+ # Ignore directories containing user credentials, local state, and settings.
182
+ # Learn more at https://abstra.io/docs
183
+ .abstra/
184
+
185
+ # Visual Studio Code
186
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
187
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
188
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
189
+ # you could uncomment the following to ignore the entire vscode folder
190
+ # .vscode/
191
+
192
+ # Ruff stuff:
193
+ .ruff_cache/
194
+
195
+ # PyPI configuration file
196
+ .pypirc
197
+
198
+ # Cursor
199
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
200
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
201
+ # refer to https://docs.cursor.com/context/ignore-files
202
+ .cursorignore
203
+ .cursorindexingignore
204
+
205
+ # Marimo
206
+ marimo/_static/
207
+ marimo/_lsp/
208
+ __marimo__/
@@ -0,0 +1,49 @@
1
+ repos:
2
+ # General file hygiene
3
+ - repo: https://github.com/pre-commit/pre-commit-hooks
4
+ rev: v5.0.0
5
+ hooks:
6
+ - id: trailing-whitespace
7
+ exclude: ^tests/integration/fixtures/
8
+ - id: end-of-file-fixer
9
+ exclude: ^tests/integration/fixtures/
10
+ - id: mixed-line-ending
11
+ args: [--fix=lf]
12
+ exclude: ^tests/integration/fixtures/
13
+ - id: check-yaml
14
+ - id: check-toml
15
+ - id: check-json
16
+ - id: check-merge-conflict
17
+ - id: check-added-large-files
18
+ args: [--maxkb=500]
19
+ - id: debug-statements
20
+ - id: check-case-conflict
21
+ - id: no-commit-to-branch
22
+ args: [--branch, main]
23
+
24
+ # Ruff: lint + auto-fix
25
+ - repo: https://github.com/astral-sh/ruff-pre-commit
26
+ rev: v0.15.2
27
+ hooks:
28
+ - id: ruff
29
+ args: [--fix]
30
+ exclude: ^tests/integration/fixtures/
31
+ - id: ruff-format
32
+ exclude: ^tests/integration/fixtures/
33
+
34
+ # Fast local test check (excludes integration/slow suites)
35
+ - repo: local
36
+ hooks:
37
+ - id: pytest-fast
38
+ name: pytest-fast
39
+ entry: python -m pytest -m "not integration and not slow" -o addopts="-vv -ra --strict-markers --strict-config"
40
+ language: python
41
+ additional_dependencies:
42
+ - "pytest>=7.0"
43
+ - "pytest-cov"
44
+ - "hypothesis>=6.0"
45
+ - "typer>=0.9"
46
+ - "pydantic>=2.0"
47
+ - "pathspec>=0.12"
48
+ - "rich>=13.0"
49
+ pass_filenames: false
@@ -0,0 +1 @@
1
+ 3.12
@@ -0,0 +1,38 @@
1
+ # Contributing
2
+
3
+ ## Dev Setup
4
+
5
+ ```bash
6
+ pip install uv
7
+ uv venv
8
+ source .venv/bin/activate
9
+ uv pip install -e ".[dev,all]"
10
+ ```
11
+
12
+ ## Lint
13
+
14
+ ```bash
15
+ ruff check .
16
+ ruff format .
17
+ ```
18
+
19
+ ## Test
20
+
21
+ ```bash
22
+ pytest -q
23
+ pytest --cov=foldermix tests/
24
+ ```
25
+
26
+ ## Mutation Test (Batch 4)
27
+
28
+ ```bash
29
+ pip install -e ".[dev,mutation,all]"
30
+ python -m mutmut run
31
+ python -m mutmut results
32
+ ```
33
+
34
+ ## Performance Smoke Test
35
+
36
+ ```bash
37
+ FOLDERMIX_RUN_PERF_SMOKE=1 python -m pytest tests/test_perf_smoke.py -q -o addopts=
38
+ ```
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Shay Palachy-Affek
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.