RepoSnap
Overview
reposnap is a Python script designed to generate a Markdown file that documents the structure and contents of a git project. This tool is particularly useful for creating a quick overview of a project's file hierarchy, including optional syntax-highlighted code snippets.
Features
- Syntax Highlighting: Includes syntax highlighting for known file types in the generated Markdown file.
- Structure Only Option: The
--structure-onlyflag can be used to generate the Markdown file with just the directory structure, omitting the contents of the files.
Installation
pip install reposnap
Alternatively, you can clone the repository and install the required dependencies:
git clone https://github.com/username/reposnap.git
cd reposnap
pip install -r requirements.lock
Usage
Command-Line Interface
To use reposnap, run it with the following options:
reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
path: Path to the Git repository or subdirectory-h, --help: show help message and exit-o, --output: The name of the output Markdown file. Defaults tooutput.md.--structure-only: Generate a Markdown file that includes only the project structure, without file contents.--debug: Enable debug-level logging.
Examples
-
Generate a full project structure with file contents:
reposnap . -
Generate a project structure only:
reposnap my_project/ --structure-only
-
Generate a Markdown file excluding certain files and directories:
reposnap my_project/ -o output.md
Testing
To run the tests, use rye:
rye test
License
This project is licensed under the MIT License.
Acknowledgments
1 maintainer
Metadata
1 maintainer
Release files for reposnap 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| reposnap-0.3.1.tar.gz | 7.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| reposnap-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.5 kB
Release files / reposnap-0.3.1.tar.gz
| Download URL | reposnap-0.3.1.tar.gz |
|---|---|
| Size | 7.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a3c1488519052f6b5f11d9a27ec5e352f9d42491102bd21d6b17e046f39e1e9
|
|
BLAKE2b-256 checksum How to use checksums |
7aaa55e89501a9d981ed68e81125fd0235831158aeb95308c30f80d27201ac68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Release files / reposnap-0.3.1-py3-none-any.whl
| Download URL | reposnap-0.3.1-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44fa347220f6960d81bb5165e366408070ee58799559573a106754d93f080b35
|
|
BLAKE2b-256 checksum How to use checksums |
69b52564417d50e3914e30d37d8c595ca69d833361318adb0267c201ec0fec2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Security for reposnap 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
