= srcignore
`srcignore` is a Typer-based CLI that reports which files inside a project match
one or more `.gitignore`-style files.
== Installation
[source,console]
----
pip install .
----
Running the tool from source without installing works too:
[source,console]
----
PYTHONPATH=src python -m srcignore --help
----
== Usage
[source,console]
----
srcignore ls PROJECT_ROOT IGNORE_FILE... [--reverse]
----
* `PROJECT_ROOT` — directory to traverse recursively.
* `IGNORE_FILE` — one or more files containing `.gitignore`-style patterns.
By default the command prints each path, relative to `PROJECT_ROOT`, that is
matched by any provided ignore file.
Pass `--reverse` to instead print paths that are *not* matched by at least one
provided ignore file. This is handy for spotting files that would be kept by
your ignore rules.
== Examples
List everything that would be ignored by `.gitignore`:
[source,console]
----
srcignore ls . .gitignore
----
Review files that are *not* matched by `.gitignore` and `.srcignore`:
[source,console]
----
srcignore ls . .gitignore .srcignore --reverse
----
1 maintainer
Metadata
1 maintainer
Release files for srcignore 0.0.3
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 | |
|---|---|---|---|---|
| srcignore-0.0.3.tar.gz | 2.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| srcignore-0.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 5.0 kB
Release files / srcignore-0.0.3.tar.gz
| Download URL | srcignore-0.0.3.tar.gz |
|---|---|
| Size | 2.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
29f1da4e6325ce0c4d2d757355777fbcefefa80dc7d7057aea57811b55d63381
|
|
BLAKE2b-256 checksum How to use checksums |
42cd7e4b53320be2993f8e144b5f8b632c0a6af098d5ed7b032190fd93aadc18
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.0
|
Release files / srcignore-0.0.3-py3-none-any.whl
| Download URL | srcignore-0.0.3-py3-none-any.whl |
|---|---|
| Size | 3.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bc6878bbefc82e6a61e7b987544a6e480daa2764a21b4652de3d1ecbb71f990a
|
|
BLAKE2b-256 checksum How to use checksums |
e629561c23a6de6e83b4d2de5fabd366c45655e791dbfb659d63c8455b436ef6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.0
|
Security for srcignore 0.0.3
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.
