pyenvdiff 0.1.0

Command Usage

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

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

python -m pyenvdiff.compare my_environment.yaml

Or compare two from any environment

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

Programmatic Usage

>>> from pyenvdiff import Environment

>>> e = Environment()
>>> e.to_yaml('my_env.yaml')

>>> o = Environment.from_yaml('other_env.yaml')

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

Web Usage

An alpha-level web-based comparison tool is available to browse and compare. PyEnvDiff ships with a default API Key, which is severly throttled. Some jerk is likely to abuse it, but until then, try it out.

Get a free personal API Key.

Install your own API key by setting a global environment variable “PYENVDIFF_API_KEY”, set to the api key.

From any two python interpreters, you can run:

python -m pyenvdiff.post --email your.email@someserver.com

or…

python -m pyenvdiff.post --domain your.website.com

…for more optional meta data fields:

python -m pyenvdiff.post -h

Which should output… something like the below, (once for each environment you run it).

Posting environment information to https://osa.pyenvdiff.com
Using API KEY: ...
Successful POST, use SHA XXXX for reference or comparison.

Then, use that SHA to fill in the link below:

https://pyenvdiff.com/view.html?sha=XXX

After you’ve collected another SHA from another environment…use the link format below, where XXXX and YYYY are two relevant SHAs.

https://pyenvdiff.com/compare.html?left=XXXX&right=YYYY

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 manditory, nor automatically installing, dependencies.

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 more advanced HTML-based comparison.

pip install ghdiff

Under the hood

• Zero dependency, pure-python, harmless 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.