circuits / docs /

Full commit
= Downloading and Installing Circuits =


Circuits can be installed in any number of ways; using setuptools'
{{{easy_install}}}, from source, or using a binary installer. It's
highly recommended that you try to install circuits using setuptools
or from source.

== Setuptools ==
To instlal Circuits using setuptools' {{{easy_install}}}
run the following command in your terminal/console:

$ easy_install circuits

''Windows Users'': Run the above in your __Command Prompt__.

== Source ==
To install CIrcuits from source:

 1. Download Circuits from either:
  * [> Python Package Index]
  * [> CIrcuits Website]

 2. Extract archive and Install:
$ tar zxvf circuits--xxx.tar.gz
$ python build install

''Windows Users'':
 * Use your favourite tool to extract the archive, eg: Winzip
 * Open your __Command Prompt__ to the extracted path.
 * Type: {{{python build install}}}

=== Specifying an alternative installation path ===
To specify an alternative installation path, use one of the following options:
 * {{{--prefix=<path>}}} to install to <path>
 * {{{--home=<home>}}} to install to home directory <home>

=== Installing in Development mode ===
To install circuits in development mode, use the {{{develop}}} command
instead of {{{install}}} This allows you to easily update/upgrade circuits
and not have to worry about re-installing.

== Prerequisites ==
 * Python 2.5 or greater (''Also works with Python 3.x``)

=== Setting up setuptools: ===
On Windows:
 download and then run it from
 the command line.

 If you have curl or  wget installed you can do this with a single command:

$ curl | sudo python

== Validate the installation: ==
To check your installation of circuits, type:

$ python -c "import circuits"

If everything worked, nothing should be displayed.

Also tryr and run the [source:examples/ Hello World!] example:

cd examples

You should get the following output:

$ python
Hello World
[.. Up]