https://github.com/neighborhoods/pipenv-devcheck

https://github.com/neighborhoods/pipenv-devcheck

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/neighborhoods/pipenv-devcheck
• Owner: neighborhoods
• License: mit
• Created: 2020-01-24T20:48:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-15T16:34:30.000Z (over 3 years ago)
• Last Synced: 2023-03-03T04:03:21.213Z (almost 2 years ago)
• Language: Python
• Size: 67.4 KB
• Stars: 1
• Watchers: 18
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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!

## 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.