Nagare installation

Nagare installation#

1. Stackless Python installation#

The Nagare framework uses Stackless Python (version 2.5.2 or above).

1. Stackless Python installation#

First, search into your Linux distribution packages if Stackless Python >= 2.5.2 is available.

Else, to install Stackless Python from its sources, to the <STACKLESS_HOME> directory, do:

cd /tmp
wget https://github.com/stackless-dev/stackless/archive/refs/tags/v2.7.18-slp.zip
unzip v2.7.18-slp.zip

cd stackless-2.7.18-slp
./configure --prefix=<STACKLESS_HOME>
make all
make install

Note

  • If the <STACKLESS_HOME> is a system directory (like /opt or /usr/local), you will have to be logged as root to launch the last make install command.

  • Some packages can be needed for the installation of Stackless Python and Nagare, especially some “devel” ones. For example, with debian/ubuntu, you would have to install:

    sudo apt-get install ca-certificates wget gcc libbz2-dev libgdbm-dev libc6-dev libreadline6-dev libsqlite3-dev libssl-dev make xz-utils zlib1g-dev libyaml-dev libxml2-dev libxslt1-dev

2. Nagare installation#

The framework can be installed system-wide where every users can use it or into a dedicated directory called a “virtual environment”.

Creating a virtual environment is the standard and recommended way because such installation doesn’t modify the configuration of the stackless Python interpreter and doesn’t require root privileges.

2.1. Virtual environment installation#

To create a virtual environment into the <NAGARE_HOME> directory, download virtualenv and launch it with Stackless Python.

On Linux:

cd /tmp
wget https://pypi.python.org/packages/d4/0c/9840c08189e030873387a73b90ada981885010dd9aea134d6de30cd24cb8/virtualenv-15.1.0.tar.gz
tar xvf virtualenv-15.1.0.tar.gz

<STACKLESS_HOME>/bin/python virtualenv-15.1.0/virtualenv.py <NAGARE_HOME>

On Windows:

  1. Download and launch the Python Win32 extensions

  2. Download the virtualenv archive and extract the file virtualenv.py (you may need an archiver like 7-zip or winrar).

    then launch:

    <STACKLESS_HOME>\python.exe virtualenv.py <NAGARE_HOME>

The final step is to install the framework into this newly created virtual environment.

On Linux:

<NAGARE_HOME>/bin/easy_install 'nagare[full]'

On Windows:

<NAGARE_HOME>\Scripts\easy_install.exe nagare[full]

2.2. System-wide installation#

If Stackless Python is installed in a system directory, you will need to have the root privileges.

First, install easy_install by downloading ez_setup.py and launch it with stackless Python.

Second, install the framework on Linux:

<STACKLESS_HOME>/bin/easy_install 'nagare[full]'

or, on Windows:

<STACKLESS_HOME>\Scripts\easy_install.exe nagare[full]

See the following chapter if you don’t want to install the framework with all its modules.

3. Installation options#

The framework installation is modular. The command easy_install nagare installs only the framework core with the minimum number of features. More features, called “extras”, can be installed with the syntax easy_install 'nagare[extra1,extra2...]'.

Currently, the available extras are:

  • debug – install the debug web page, displayed when an exception is raised

  • database – install the Python modules needed, for an application, to access relational databases

  • doc – install the Python modules needed to generate the framework documentation

  • test – install the unit tests manager

  • i18n – install the internationalization modules

  • full – install all of the above extras (i.e easy_install 'nagare[full]' is equivalent to easy_install 'nagare[debug,database,doc,test,i18n]')

4. Developers framework installation#

To work with the latest framework sources directly from its repository, first create a virtual environment into the <NAGARE_HOME> directory: download virtualenv and launch it with Stackless Python.

cd /tmp
wget https://pypi.python.org/packages/d4/0c/9840c08189e030873387a73b90ada981885010dd9aea134d6de30cd24cb8/virtualenv-15.1.0.tar.gz
tar xvf virtualenv-15.1.0.tar.gz

<STACKLESS_HOME>/bin/python virtualenv-15.1.0/virtualenv.py <NAGARE_HOME>

Second, grab the framework sources from the repository:

cd <NAGARE_HOME>
git clone https://github.com/nagareproject/core.git

Third, install the framework from the sources:

cd core
<NAGARE_HOME>/bin/python setup.py develop
<NAGARE_HOME>/bin/easy_install 'nagare[full]'

You can now work with the sources of the framework in <NAGARE_HOME>/core/nagare and, when you want to update the sources from the repository, do:

cd <NAGARE_HOME>/core
git pull
<NAGARE_HOME>/bin/python setup.py develop

5. Testing the installation#

To test the installation, launch the adminstrative interface:

<NAGARE_HOME>/bin/nagare-admin serve admin

or, in Windows:

<NAGARE_HOME>\Scripts\nagare-admin.exe serve admin

which must results in the following display:

Application 'app admin' registered as '/admin'
Application 'app admin' registered as '/'
serving on http://127.0.0.1:8080

Then you can browse at http://127.0.0.1:8080/admin to look at the administrative interface.

Contents