Skip to content

Update README.rst #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gdgellatly wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update README.rst #301

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebab638
Update README.rst
gdgellatly Aug 1, 2022
40ff3fa
Update README.rst
gdgellatly Aug 1, 2022
84631c9
Merge branch 'master' into doc-link3
gdgellatly Mar 5, 2025
4c885a3
Update README.rst
gdgellatly Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,32 @@
: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

===============================
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://oca.github.io/openupgradelib

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``
Copy link
Member

@StefanRijnhart StefanRijnhart Mar 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the release to Pypi process is automated, the library is released regularly and there is no need to install from Github anymore.

Copy link
Contributor Author

@gdgellatly gdgellatly Mar 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol ffs, try and do something little 3 years ago. Will fix Wednesday.

Copy link
Contributor

@MiquelRForgeFlow MiquelRForgeFlow Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gdgellatly


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