Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 2.71 KB

INSTALL.rst

File metadata and controls

97 lines (63 loc) · 2.71 KB

Installing Formic

Prequisites

Platform and dependencies:

  • Formic requires Python 2.6+ or Python3.4+
  • It has been tested on
    • Mac OS X (Lion and Mountain Lion)
    • Ubuntu 11.10 and 12.04LTS
    • Windows XP, Windows 7 (Home Premium) and Windows 10.

Formic can work on any Python 2.6+ or Python 3.4+ system; if not, please contact the maintainer or file an issue.

Formic has no runtime dependencies outside the Python system libraries.

Installation options

There are three ways to obtain Formic shown below, in increasing difficulty and complexity. You need only pick one:

Option 1: Automated install

Simplest: use:

$ easy_install formic2

or:

$ pip install formic2

Option 2: Source install

  1. Download the appropriate package from Formics page on the Python Package Index. This is a GZipped TAR file.

  2. Extract the package using your preferred GZip utility.

  3. Navigate into the extracted directory and perform the installation:

    $ python setup.py install

Option 3: Check out the project

If you like, you could download the source and compile it yourself. The source is now on GitHub.

After checking out the source, navigate to the top level directory and build:

$ python setup.py install

Validating the installation

After installing, you should be able to execute Formic from the command line:

$ formic --version

If you downloaded the source, you can additionally run the unit tests. This requires py.test:

$ easy_install pytest
$ pytest -v test

Compiling the documentation

Formic uses Sphinx for documentation. The source files are in the 'doc' subdirectory. To build the documentation,

  1. Ensure that formic has been installed and is visible on the path so you can start Python and import formic, eg:

    $ cd /anywhere/on/filesystem
$ python
Python 2.7.1 (r271:86832, Jul 31 2011, 19:30:53)
[GCC 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2335.15.00)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import formic
>>> exit()
$

  2. Navigate to Formic's top level directory, then:

    $ sphinx-build doc htmlout

The documentation will be in the ./htmlout subdirectory.

Note

Only HTML generation has been tested.

Note

If you get errors that Sphinx cannot import Formic's packages, you may not have installed the module correctly. Try reinstalling it, eg 'python setup.py develop' or 'python setup.py install'