From ebab6388d973136b36b08972b4694d07e2956197 Mon Sep 17 00:00:00 2001 From: Graeme Gellatly Date: Mon, 1 Aug 2022 22:08:22 +1200 Subject: [PATCH 1/3] Update README.rst Add link to API Add license badge Format a little --- README.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5d2447ee..10e011b6 100644 --- a/README.rst +++ b/README.rst @@ -13,24 +13,32 @@ .. image:: https://img.shields.io/pypi/v/openupgradelib.svg :target: https://pypi.python.org/pypi/openupgradelib :alt: Pypi Package + +.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0 + :alt: License: AGPL v3 =============================== OpenUpgrade Library =============================== A library with support functions to be called from Odoo migration scripts. +For information on how to develop and contribute -* Free software: AGPL-3 license -* Documentation: https://openupgradelib.readthedocs.org. +* Contributor Documentation: https://openupgradelib.readthedocs.org. Install ------- -Always get the latest version through: +Always get the latest version through either pip or pip3: -pip/pip3 install --ignore-installed git+https://github.com/OCA/openupgradelib.git@master +``pip install --ignore-installed git+https://github.com/OCA/openupgradelib.git@master`` Features -------- -* TODO +The OpenUpgrade library contains all kinds of helper functions for wrting scripts to migrate between odoo versions, in OpenUpgrade itself or in the migration scripts of your own module (in either major or minor version upgrades). Once installed, it can be used in your scripts as + +``from openupgradelib import openupgrade`` + +* Library Documentation: https://oca.github.io/OpenUpgrade/API.html From 40ff3fa5eb292566a332646a2c06ca5e10d53215 Mon Sep 17 00:00:00 2001 From: Graeme Gellatly Date: Mon, 1 Aug 2022 22:15:25 +1200 Subject: [PATCH 2/3] Update README.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per Review Co-authored-by: Miquel Raïch --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 10e011b6..635fc346 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ :target: https://pypi.python.org/pypi/openupgradelib :alt: Pypi Package -.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png :target: https://www.gnu.org/licenses/agpl-3.0 - :alt: License: AGPL v3 + :alt: License: AGPL-3 =============================== OpenUpgrade Library From 4c885a3a9fac3c3b75d920a7a58f39694b1068d6 Mon Sep 17 00:00:00 2001 From: Graeme Gellatly Date: Thu, 6 Mar 2025 11:08:25 +1300 Subject: [PATCH 3/3] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 67dc78a0..25ee8589 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ .. image:: https://img.shields.io/pypi/v/openupgradelib.svg :target: https://pypi.python.org/pypi/openupgradelib :alt: Pypi Package - + .. image:: https://img.shields.io/badge/license-AGPL--3-blue.png :target: https://www.gnu.org/licenses/agpl-3.0 :alt: License: AGPL-3