<commit_before>.. _contribute:

#################
Developer's guide
#################

.. contents:: Sections:
   :local:
   :backlinks: top

.. _installation-with-buildout:

********************************************
Connector with batteries included (buildout)
********************************************

Installing the buildout
=======================

When you want to install the Magento connector, you can either install it manually
using the :ref:`installation-guide` or either using our automated Buildout_ recipe.
The manual installation is recommended if you need to add it on an existing
installation or if you want to control your environment in your own manner.

The Buildout_ recipe is an all-in-one package which installs OpenERP, the
connector and provides many facilities for the developers. It includes
developer tools such as:

* Run the tests on the connector / Magento connector
* Build the connector / Magento connector documentation
* Launch the Jobs Workers (for multiprocessing)

So we highly recommend to use this recipe for development.

In order to use it, first get the branch::

    $ bzr branch lp:openerp-connector-magento/7.0-buildout

Then bootstrap it::

    $ python -S bootstrap.py

Then run the buildout on the configuration file (eventually change options)::

    $ bin/buildout

If this is is the first time you use it, you'll need to
create a PostgreSQL user whose name is `openerp_magento7` and password is
`<PASSWORD>` (according to what you put in the configuration file).
You will also need to create the database.

::

    $ createuser -W openerp_magento7  # then respond to the questions
    $ createdb openerp_magento7 -O openerp_magento7


Head over the next sections to discover the included tools

.. _Buildout: http://www.buildout.org

Start OpenERP<commit_msg>as suggested, add a note on bzr login when running the buildout recipe<commit_after>.. _contribute:

#################
Developer's guide
#################

.. contents:: Sections:
   :local:
   :backlinks: top

.. _installation-with-buildout:

********************************************
Connector with batteries included (buildout)
********************************************

Installing the buildout
=======================

When you want to install the Magento connector, you can either install it manually
using the :ref:`installation-guide` or either using our automated Buildout_ recipe.
The manual installation is recommended if you need to add it on an existing
installation or if you want to control your environment in your own manner.

The Buildout_ recipe is an all-in-one package which installs OpenERP, the
connector and provides many facilities for the developers. It includes
developer tools such as:

* Run the tests on the connector / Magento connector
* Build the connector / Magento connector documentation
* Launch the Jobs Workers (for multiprocessing)

So we highly recommend to use this recipe for development.

.. note:: The buildout recipe uses ``bzr`` to get the branches.
          Ensure that ``bzr`` is configured with the launchpad login
          and the SSH key, or it may fail to get the branches.

In order to use it, first get the branch::

    $ bzr branch lp:openerp-connector-magento/7.0-buildout

Then bootstrap it::

    $ python -S bootstrap.py

Then run the buildout on the configuration file (eventually change options)::

    $ bin/buildout

If this is is the first time you use it, you'll need to
create a PostgreSQL user whose name is `openerp_magento7` and password is
`<PASSWORD>` (according to what you put in the configuration file).
You will also need to create the database.

::

    $ createuser -W openerp_magento7  # then respond to the questions
    $ createdb openerp_magento7 -O openerp_magento7


Head over the next sections to discover the included tools

.. _Buildout: http://www.buildout.org

Start OpenERP
{'fraction_non_alphanumeric': 0.12602880658436214, 'fraction_numerical': 0.0030864197530864196, 'mean_word_length': 4.401388888888889, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5315459', 'n_tokens_mistral': 1048, 'n_tokens_neox': 997, 'n_words': 486}