Skip to main content

PyEnvDiff

https://img.shields.io/pypi/v/pyenvdiff.svg https://travis-ci.org/jnmclarty/pyenvdiff-lib.svg?branch=master Documentation Status

Python environment comparison tool. Maximized for compatibility between versions 2.6 to 3.8, pypy, operating systems, distributions, and forks! Virtualenv, pyenv, pyvenv, conda and system!

via Command-Line

From the command line, to get information on the current environment:

python -m pyenvdiff.info

Serialize the information to a file…

python -m pyenvdiff.info my_environment.json

Switch to another environment (you’ll need pyenvdiff installed in both)

python -m pyenvdiff.compare my_environment.json

Or compare two from any environment

python -m pyenvdiff.compare my_environment.json my_other_environment.json

via Hub-Based Compare

An HTTP-based service comes with pyenvdiff, all without dependencies (thanks to a copy of bottle). It stores environment information in RAM, for as long as it runs. This service should be considered alpha-stage.

To launch the built-in hub (server):

python -m pyenvdiff.hub

Then navigate in your browser to the URL it gives you to see the menu of available options. Before you send information about other environments on the same machine, your options will be limited to just viewing the server’s environment.

Samples of the Hub Landing Page and the Environment Information Page illustrate the features.

From one or more other environments run:

python -m pyenvdiff.post_to_hub

A URL will be displayed to view environment information from any machine on the same network.

Navigate back to the base URL, you’ll see more options to compare the two environments.

A Sample of the Environment Diff Page illustrate what the diff can do (if `ghdiff` is installed for the hub).

Programmatic Usage

>>> from pyenvdiff import Environment

>>> e = Environment()
>>> e.to_file('my_env.json')

>>> o = Environment.from_file('other_env.json')

>>> e == o
True

>>> print(e)
... # prints a dump of the environment details

>>> from pyenvdiff import EnvironmentDiff
>>> ed = EnvironmentDiff(e, o)
>>> print(ed)
... # prints a diff of the two environments

Sooo much room for activities!

  • Compare dev, test & prod!

  • Works on my machine, strange it doesn’t work on yours

  • Confirming deployments

  • Auditing user desktops, servers, research environments & ecosystems

  • Filing (or requesting) bug reports

Installation

There are no mandatory, nor automatically installing, dependencies. There are optional dependencies which increase.

pip install pyenvdiff

OR just copy & paste pyenvdiff anywhere on PYTHONPATH

There is one optional dependency. The core functionality doesn’t use it. It’s only needed for pretty HTML-based comparisons via the web.

pip install ghdiff

Under the hood

  • Robust and organized object model collects and serializes environment information.

  • Zero dependency, pure-python, harmless install! Simply pip install pyenvdiff or copy anywhere on PYTHONPATH.

  • As-needed import statements, to maximize compatibility across python flavours.

  • Favours compatible python-code over succinct or newer-style python-code

  • Free software: BSD license

  • Documentation: https://pyenvdiff.readthedocs.io.

Credits

This package was started with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.3.0 (2018-11-18)

  • Add bottle-based Hub for P2P Comparisons

  • Added Python 3.8 Support

  • Fixed bug impacting Ubuntu 18 [GH Issue #15]

  • Removed documented support for Third-party API-enabled comparisons

  • Enhanced the SysPrefix collector. [PR#16]

  • Add error attribute to Collectors. [PR#16]

  • Fixed Docs on PyPI, added comments inline.

  • Improved language in console output.

0.2.0 (2018-06-8)

  • Refactor info.py into environment.py to account for regression in cpython micro release (#5) [PR #6]

  • Change file format from yaml to json with sorted keys (#4) [PR #7]

  • Remove pyenvdiff.com as default server. [PR #8]

  • Simplify user-created custom Collector. [PR #8]

  • Enable user-created custom POST command. [PR #8]

  • Add more Collectors (OSEnviron, UserName, HomeDirectory, SysPrefix). [PR #9]

  • Add transparency to systematically disclose what information is collected. [PR #9]

  • Add invasive property [PR #9]

  • Make compatible with pip 10. [PR #10]

  • Enhance PipDistribution output. [PR #10]

0.1.0 (2016-12-24)

  • First release on PyPI.

Metadata

Release files for pyenvdiff 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyenvdiff 0.3.0
File Size Uploaded Provenance Actions
pyenvdiff-0.3.0.tar.gz 79.3 kB Without provenance Details for pyenvdiff-0.3.0.tar.gz

Release files / pyenvdiff-0.3.0.tar.gz

Download URL pyenvdiff-0.3.0.tar.gz
Size 79.3 kB
Tags Source
SHA-256 checksum
How to use checksums
2034fda1c8403ede0eebd17603bfd312b13f76d3a787d836e68ffd9f09f36b65
BLAKE2b-256 checksum
How to use checksums
9c9aa783c33eaab39067dca7f28135c83e854c6bbf0f0a36c45e02ec28b7c82b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Security for pyenvdiff 0.3.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page