aperiot

	Welcome
	Aperiot at glance
	Distribution
	Documentation
	Credits

Distribution

The latest version is 0.1.2.

Requirements

Software

aperiot requires the following software packages:

Python 2.4 or newer (it can be obtained at http://www.python.org)

Operating System/Hardware

aperiot runs on any platform that can run Python. This includes several varieties of Unix/Linux, MS-Windows, and MacOS.

It has been tested on Linux (Fedora Core 5, Linux kernel 2.6.17) and Windows XP.

Most Linux distributions include Python, but some such as SuSE and Debian, seem to lack some packages of Python's standard library which are needed (in particular the distutils package.) This results in an error message when attempting to install or run aperiot. This may be fixed by installing the Python ``developer'' packages available for the Linux distribution from the corresponding vendor's repository, or alternatively doing a clean install of Python from Python's official website.

Distribution

aperiot is available in the following formats:

Format File Size

Source ZIP archive aperiot-0.1.2.zip 245 KB

Source tarball (gzipped tar archive) aperiot-0.1.2.tar.gz 232 KB

Installing

Please read the licence terms found here or in the file LICENCE found in the distribution.

Extract the archive in some directory dir.
This will create a directory called aperiot-0.1.2 under dir.

Open a console window and go to the extracted directory by typing:
cd path_to_dir\aperiot-0.1.2
on Windows, or
cd path_to_dir/aperiot-0.1.2
on Unix/Linux, where path_to_dir is the absolute path of dir.

Execute the install script by typing the following on the command-line:
python setup.py install

And it's done. The directories where the files have been installed will be recorded in the file install_data.py. The full list of files is recorded into a filed called installed_files.lst. Do not modify these files unless you are absolutely sure you know what you are doing.

IMPORTANT: If, at a later time you want to uninstall the package, be sure to either keep your extracted distribution directory or, alternatively, do not move the installed files to a different location so that the uninstaller can find them in the default locations.

The executable script (apr) will be installed in the default python's scripts directory (the install_scripts attribute in the install_data.py file.) Usually this is /usr/local/bin or /usr/bin on Unix/Linux, and on Windows, the Scripts subdirectory of your Python installation (e.g. C:\Program Files\Python24\Scripts.)

You might want to add this path (the install_scripts attribute in the install_data.py file.) to your system's path environment variable for easy access to the program.

The Python packages will be installed in the site-packages of your Python installation (the install_xxxxlib attributes in the install_data.py file.) Usually this is /usr/local/lib/python24/site-packages or, on Windows, /usr/lib/python24/site-packages on Unix/Linux, or the Lib\site-packages subdirectory of your Python installation (e.g. C:\Program Files\ Python24\Lib\site-packages.)

(For more detailed installation instructions see the INSTALL file included in the distribution.)

Uninstalling

Open a console window and go to the directory where you extracted the distribution¹:
cd path_to_dir\aperiot-0.1.2
on Windows, or
cd path_to_dir/aperiot-0.1.2
on Unix/Linux, where path_to_dir is the absolute path of dir.

Execute the uninstall script by typing the following on the command-line:
python setup.py uninstall

This will remove all files previously installed, and will leave an archived copy (zip file or tarball) of the distribution in the path_to_dir/aperiot-0.1.2/dist directory. You can remove it or reinstall the package from it.

Footnotes:

¹If you removed the distribution directory but you followed the default install procedure, then download, extract and reinstall the distribution again before uninstalling. If you didn't follow the default install procedure, you'll have to manually locate and delete the package directories and the scripts.