Skip to content

Installation

Jessy Williams edited this page Apr 21, 2020 · 8 revisions

The latest stable version of mnamer can be installed from PyPI, the Python Package Index. mnamer v2 requires mnamer 3.6+.

Installing for the Current User

The recommended option for most users. Its the easiest and won't interfere with packages installed by system Python.

  • Install by running pip3 install --user mnamer.
  • Update by running pip3 install --user --upgrade mnamer.
  • Uninstall by running pip3 uninstall mnamer.

Installing Globally

This option will make mnamer available for all user accounts. Generally only recommended under Windows. Installed packages may interfere with system managed packages under MacOS and Linux so use with caution. sudo may be required to run these commands.

  • Install by running pip3 install mnamer.
  • Update by running pip3 install --upgrade mnamer.
  • Uninstall by running pip3 uninstall mnmaer.

Installing Using pipx

pipx is like a package manager for Python executables. It will install packages under a virtual environment, completely isolating the package and its requirements.

  • Install by running pipx install mnamer.
  • Update by running pipx upgrade mnamer.
  • Uninstall mnamer by running pipx uninstall mnamer.

Installing Latest WIP Version from GitHub

So long as unit tests are passing its probably safe to install the latest mnamer version straight from this repository. This requires git being installed on your machine. You can pass the --user argument here too to install in your home directory.

  • Install by running pip3 install 'git+https://github.com/jkwill87/mnamer'.
  • Update by running pip3 install --update 'git+https://github.com/jkwill87/mnamer'.
  • Uninstall by running pip3 uninstall mnamer.