kumi/contentsnapshot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
No description
8 commits 1 branch 2 tags 47 KiB
Find a file
Exact
Kumi cef6aa4248
All checks were successful
Build and Publish Python Package / build-and-publish (push) Successful in 2m21s
Details
fix: Add main() function for executable, version bump
2025-05-27 16:43:21 +02:00
.forgejo/workflows fix(?): Remove apparently unpopulated env variables? 2025-05-27 09:36:09 +02:00
content_snapshot fix: Add main() function for executable, version bump 2025-05-27 16:43:21 +02:00
.gitignore feat: Current version of snapshot exporter 2025-05-27 08:53:14 +02:00
LICENSE feat: Current version of snapshot exporter 2025-05-27 08:53:14 +02:00
pyproject.toml fix: Add main() function for executable, version bump 2025-05-27 16:43:21 +02:00
README.md chore: Add index-url to installation command 2025-05-27 08:54:25 +02:00

README.md

ContentSnapshot

Create a snapshot of your project files' content while respecting ignore patterns.

Installation

pip install content-snapshot --index-url https://git.private.coffee/api/packages/kumi/pypi/simple

Usage

Command Line

content-snapshot /path/to/your/project

Python API

from content_snapshot import get_files_content_recursively, load_ignore_patterns

directory_path = "/path/to/your/project"
ignore_spec = load_ignore_patterns(directory_path)
snapshot = get_files_content_recursively(directory_path, ignore_spec)
print(snapshot)

Ignore Files

ContentSnapshot respects the following ignore files:

  • .gitignore - Standard Git ignore patterns
  • .snapshotignore - Additional patterns specific to ContentSnapshot

License

This project is licensed under the MIT License. See the LICENSE file for details.