Skip to main content

Check the contents of an SDist vs. git

Project description

check-sdist

Actions Status PyPI version PyPI platforms

To run:

$ pipx run check-sdist

You can add --no-isolation to disable build isolation (faster, but must preinstall build deps), --source-dir to select a different source dir to check, and --inject-junk to temporarily inject some common junk files while running.

To use the development version:

$ pipx run --spec git+https://github.com/henryiii/check-sdist check-sdist

To use the pre-commit integration, use this in your .pre-commit-config.yaml:

- repo: https://github.com/henryiii/check-sdist
  rev: v0.1.0
  hooks:
    - id: check-sdist
      args: [--inject-junk]
      additional_dependencies: [] # list your build deps here

Or, slower, but doesn't require build dependency listing:

- repo: https://github.com/henryiii/check-sdist
  rev: v0.1.0
  hooks:
    - id: check-sdist-isolated
      args: [--inject-junk]

To configure, these options are provided for your pyproject.toml file:

[tool.check-sdist]
sdist-only = []
git-only = []
default-ignore = true

You can add .gitignore style lines here, and you can turn off the default ignore list, which adds some default git-only files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

check_sdist-0.1.0.tar.gz (11.4 kB view hashes)

Uploaded Source

Built Distribution

check_sdist-0.1.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page