Skip to content
Snippets Groups Projects
Commit c0b9ea43 authored by Vincent Hatakeyama's avatar Vincent Hatakeyama
Browse files

:books: improve readme, remove obsolete development instructions

parent d69c1fba
No related branches found
No related tags found
1 merge request!152📚 improve readme, remove obsolete development instructions
......@@ -13,6 +13,8 @@
[bumpversion:file:run_tests]
[bumpversion:file:README.rst]
[bumpversion:file:start]
[bumpversion:file:odoo_scripts/__init__.py]
Installing Odoo Scripts for development
---------------------------------------
:pep:660 defines `Editable installs for pyproject.toml based builds`, this should not be necessary if your pip version is recent enough.
This should be enough to install in dev mode:
.. code-block:: SH
python3 -m pip install --user -e ".[docker,import_sql,conf2reST,source_control]" --upgrade
This can be tried to install in dev mode without using the toml file:
.. code-block:: SH
mv pyproject.toml pyproject.toml\~
python3 -m pip install --user -e ".[docker,import_sql,conf2reST,source_control]" --upgrade
mv pyproject.toml\~ pyproject.toml
......@@ -7,7 +7,7 @@
Changes to docker_isort so that it can be used to apply changes.
Compatibility with longpolling.
Compatibility with long polling.
Extract version number with setuptools-scm.
......@@ -11,7 +11,7 @@
Extract version number with setuptools-scm.
Update to use only pyproject.toml and remove setup.py.
Update to use only pyproject.toml and remove setup.py, indicating to use pip 10.0+ to install.
Add tests for python 3.11.
......
......@@ -7,5 +7,5 @@
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``.
pip need to be more recent than version 10.0 to use it to install.
......@@ -11,6 +11,8 @@
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 recommend way to install this module is to run ``python3 -m pip install hg+https://orus.io/xcg/odoo_scripts@16.10.0#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@16.10.0#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``.
To upgrade Odoo scripts, just add ``--upgrade`` to the end of the command.
......@@ -13,8 +15,8 @@
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``.
To upgrade Odoo scripts, just add ``--upgrade`` to the end of the command.
It can also be cloned it before running ``python3 -m pip install .`` in the clone directory.
It can also be cloned before running ``python3 -m pip install .`` in the clone directory, and with pip version 21.3+ and a recent setuptools, it can use the cloned repository by adding ``--editable``/``-e``.
.. important:: As there is no way of indicating sections (worse, it is handling them incorrectly), do not use ``python3 setup.py install``.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment