Skip to main content

Pipenv/setup.py dependency comparison tool

Project description

pipenv-devcheck

pipenv-devcheck is a command-line utility for helping python package developers ensure that their development environments match what they are expecting of their users' environments.

At Neighborhoods, some developers utilize Pipenv as a dependency management system during development, allowing for assurance that an entire development team is working with an identical environment. While Pipenv is an extremely helpful development tool, it is not an all-in-one solution to development challenges.

When a user installs a python package, for example, the dependencies they need are specified not in Pipenv's Pipfile, but in setup.py. As a result, it is possible for a developer to change the dependencies they are using without reflecting those changes in the environment expected for package usage.

pipenv-devcheck is a lightweight command-line tool to check for such mistakes. If a project is found to have discrepancies between the development and user environments, an error is thrown, allowing for detection by CI tools. While simple in nature, this check can prevent annoying issues such as revising a package release to update requirements, or developers having difficulty with helping users debug due to a hidden environment difference.

After installation, simply run pipenv-devcheck at the root of a package via the command line to use!

Visible Examples

To interact with this tool and see how its output will be displayed, simply modify demo/demo_Pipfile and demo/demo_setup.py to introduce various version discrepancies, and then run the following code:

import pipenv_devcheck

pipenv_devcheck.compare_deps("test/test_deps/dummy_setup.py".
                             "test/test_deps/dummy_Pipfile")

Disclaimer

This tool is not designed to check for implicit compatibility issues between package versions. It will only check if the version numbers specified in a package's dependency files theoretically are compatible. Please consult the source of the individual packages if implicit compatibility issues arise.

This project is licensed under the terms of the MIT license.

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

pipenv-devcheck-0.1.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

pipenv_devcheck-0.1.1-py2.py3-none-any.whl (7.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pipenv-devcheck-0.1.1.tar.gz.

File metadata

  • Download URL: pipenv-devcheck-0.1.1.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4

File hashes

Hashes for pipenv-devcheck-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5ab589eb7e024d37a3b5a50914cc3cbce24f5bad88b49a1b38d28a00983aa10d
MD5 e62ec02162f9d7d571f14f6088fccd11
BLAKE2b-256 bf6fe6f012b2dd924ae7f2d70c8a3322b7e1c47fb404ea41ccf53ed569b36e83

See more details on using hashes here.

File details

Details for the file pipenv_devcheck-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pipenv_devcheck-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4

File hashes

Hashes for pipenv_devcheck-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c288df82962307965c0a5653f5a0fef73d3fa6afe9686a933a3fa3560d9a2d17
MD5 05cd3c6eaf12b56af9e01c0a06e1fc0e
BLAKE2b-256 db71a0e955df224e6a0de03a8bcf4118af527fe9e542661000b2013f74c3e6b3

See more details on using hashes here.

Supported by

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