Most commands can be run directly or with the image build from ``Dockerfile`` (xcgd/odoo_scripts) by indicating the command to run, but the best way to use this module is to install it. Installing will also install dependencies.
Most commands can be run directly or with the image build from ``Dockerfile`` (xcgd/odoo_scripts) by indicating the command to run, but the best way to use this module is to install it. Installing will also install dependencies.
...
@@ -5,7 +8,18 @@
...
@@ -5,7 +8,18 @@
Most commands can be run directly or with the image build from ``Dockerfile`` (xcgd/odoo_scripts) by indicating the command to run, but the best way to use this module is to install it. Installing will also install dependencies.
Most commands can be run directly or with the image build from ``Dockerfile`` (xcgd/odoo_scripts) by indicating the command to run, but the best way to use this module is to install it. Installing will also install dependencies.
The recommend way to install this module is to run ``python3 -m pip install hg+https://orus.io/xcg/odoo_scripts#egg=odoo_scripts``.
Some scripts are in other sections, because they need some specialized library, in that case you need to indicate the name of section as in ``python3 -m pip install "hg+https://orus.io/xcg/odoo_scripts#egg=odoo_scripts[docker]"``.
The prerequisites for this module or one of its section can be installed by using pip3 or the package manager; the requirements are defined in ``setup.py``.
It can also be cloned it before running ``python3 -m pip install .`` in the clone directory.
.. important:: As there is no way of indicating sections (worse, it is handling them incorrectly), do not use ``python3 setup.py install``.
Note that shell scripts are not installed, as they are meant to be replaced with more easily maintanable python scripts.
Scripts
Scripts
=======
=======
Those scripts are available when installing the package, and can also be run directly.
Those scripts are available when installing the package, and can also be run directly.
...
@@ -7,15 +21,8 @@
...
@@ -7,15 +21,8 @@
Scripts
Scripts
=======
=======
Those scripts are available when installing the package, and can also be run directly.
Those scripts are available when installing the package, and can also be run directly.
The recommend way to install this module is to run ``python3 -m pip install hg+https://orus.io/xcg/odoo_scripts#egg=odoo_scripts``, or to clone it then run ``python3 -m pip install .``.
Some scripts are in other sections, because they need some specialized library, in that case you need to indicate the name of section as in ``python3 -m pip install "hg+https://orus.io/xcg/odoo_scripts#egg=odoo_scripts[docker]"``.
The prerequisites for this module or one of its section can be installed by using pip3 or the package manager; the requirements are defined in ``setup.py``.
.. important:: As there is no way of indicating sections (worse, it is handling them incorrectly), do not use ``python3 setup.py install``.
