Installation

End user installation

pip is your friend here!

If you have it in your path, you can simply use:

pip install pyimgren

It will take care of any required dependencies and will install the latest version of pyimgren. It will also install a pyimgren command that will be directly callable from a shell (ref.).

If pip is not in your path (common on Windows), you are likely to have to use the py launcher. In that case you use pip as:

py -m pip install pyimgren

The installation is exactly the same as it is when launching directly pip. But you will have to still use the py launcher to call pyimgren from a command line (ref.).

Developer installation

The source is of course available in the source package from PyPI.

Alternatively, you can download the full source for the relevant version as a .zip file from GitHub, but the recommended way is to use :program:git to clone the repository. It will give you all the versions in one single operation, as well as a nice environment if you want to later send a pull request.

So simply do:

git clone https://github.com/s-ball/pyimgren.git pyimgren

In any case, you should then install the package in development mode and ask for the test extra dependencies:

pip install -e .[test]

That way you will automatically get the pyfakefs package which is required for the integration tests.

Note

The various untagged commits in the Git hierarchy are not guaranteed to be directly usable. At some points, some tests can fail and unexpected errors can occur. Use the master branch when you want to contribute. In any other cases, stick to a release, or be sure to pass all tests and be prepared to look into the source code if something goes wrong.