Introduction

This is the documentation for imvu.py, a library for Python to aid in creating applications that utilize the IMVU API.

Prerequisites

imvu.py works with Python 3.6 or higher. Support for earlier versions of Python is not provided. Python 2.7 or lower is not supported. Python versions below 3.6 are not supported due to the lack of typing and f-string syntax support.

Installing

You can get the library directly from PyPI:

python3 -m pip install imvu.py

If you are using Windows, then the following should be used instead:

py -3 pip install -U imvu.py

Remember to check your permissions!

Virtual Environments

Sometimes we don’t want to pollute our system installs with a library or we want to maintain different versions of a library than the currently system installed one. Or we don’t have permissions to install a library along side with the system installed ones. For this purpose, the standard library as of 3.3 comes with a concept called “Virtual Environment” to help maintain these separate versions.

A more in-depth tutorial is found on the official documentation.

However, for the quick and dirty:

  1. Go to your project’s working directory:

    $ cd your-script-source
    $ python3 -m venv script-env
    
  2. Activate the virtual environment:

    $ source script-env/bin/activate
    

    On Windows you activate it with:

    $ bot-env\Scripts\activate.bat
    
  3. Use pip like usual:

    $ pip install -U imvu.py
    

Congratulations. You now have a virtual environment all set up without messing with your system installation.