diff --git a/.bumpversion.cfg b/.bumpversion.cfg index d69c1fba8292d2ab18780615826ec25e46cfe1f6_LmJ1bXB2ZXJzaW9uLmNmZw==..c0b9ea4377560f74a66139bafb353c0ba840346a_LmJ1bXB2ZXJzaW9uLmNmZw== 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -13,6 +13,8 @@ [bumpversion:file:run_tests] +[bumpversion:file:README.rst] + [bumpversion:file:start] [bumpversion:file:odoo_scripts/__init__.py] diff --git a/DEVELOP.rst b/DEVELOP.rst deleted file mode 100644 index d69c1fba8292d2ab18780615826ec25e46cfe1f6_REVWRUxPUC5yc3Q=..0000000000000000000000000000000000000000 --- a/DEVELOP.rst +++ /dev/null @@ -1,18 +0,0 @@ -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 diff --git a/NEWS.rst b/NEWS.rst index d69c1fba8292d2ab18780615826ec25e46cfe1f6_TkVXUy5yc3Q=..c0b9ea4377560f74a66139bafb353c0ba840346a_TkVXUy5yc3Q= 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -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. diff --git a/README.rst b/README.rst index d69c1fba8292d2ab18780615826ec25e46cfe1f6_UkVBRE1FLnJzdA==..c0b9ea4377560f74a66139bafb353c0ba840346a_UkVBRE1FLnJzdA== 100644 --- a/README.rst +++ b/README.rst @@ -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``.