[IMP] install/setup: install dependencies from debian packages #1364

d-fence · 2021-12-08T10:50:47Z

This commit changes the way that Odoo python dependencies should be
installed.

Before this commit, the described way to install Odoo dependencies was
by using the pip utility.

Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.

The main reasons are:

Odoo productions instances are, most of the time, run on Debian based
systems with those package already installed
That way, a developer cannot mistakenly use a feature from a
dependency that does not exists on those production envirorments
Avoid mixes of python packages on the developer/user 's system

robodoo · 2021-12-08T10:51:26Z

Pull request status dashboard.

Xavier-Do · 2021-12-08T12:21:15Z

content/administration/install/install.rst


 .. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
         or with your system. You can use virtualenv_ to create isolated Python environments.
+         In that case, the `requirements.txt` file can be used to install the dependencies.


I think that we should specify here that -dev packages are required. It is sad to loose this list.

That means bringing back the whole pip explanation in the tip ... what do you think @AntoineVDV

d-fence · 2021-12-08T15:17:53Z

Linked to #1329

amigrave

2 cents

content/administration/install/install.rst

AntoineVDV

I find it weird to keep only some of the explanations for the pip setup while removing the others (list of -dev packages, for example). Either we recommend installing the dependencies through apt and we properly explain how to do it through pip for those who prefer, or we only mention the Debian setup. If we go for the first option, I suggest that we properly split the instructions for the two setups in two different headings, and find a nicer-looking solution later on (tabs, maybe).

I'm a bit confused about why we'd want to discourage the pip setup. Maybe @amigrave could enlighten me? And, if we do that, why do we keep (and maintain) a requirements.txt file? Also, are Debian dependencies listed in the debian/control file compatible with any supported version of Odoo?

content/administration/install/install.rst

AntoineVDV · 2021-12-10T09:44:43Z

content/administration/install/install.rst


 .. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
         or with your system. You can use virtualenv_ to create isolated Python environments.
+         In that case, the `requirements.txt` file can be used to install the dependencies.


Suggested change

In that case, the `requirements.txt` file can be used to install the dependencies.

In that case, the :file:`requirements.txt` file can be used to install the dependencies.

content/administration/install/install.rst

content/developer/howtos/rdtraining/02_setup.rst

d-fence · 2021-12-14T08:50:02Z

@AntoineVDV I splitted the installation of Python dependencies into debian/Ubuntu and The pip way.
I hope that it will not bring more confusion in the chaos...
And I'm not sure that @amigrave will agree

amigrave · 2021-12-14T09:30:39Z

@AntoineVDV I splitted the installation of Python dependencies into debian/Ubuntu and The pip way. I hope that it will not bring more confusion in the chaos... And I'm not sure that @amigrave will agree

No, I'm ok with that. I'll link from the Odoo.sh FAQ to the "preferred way" of installation.
Maybe mention that the Odoo platforms (Odoo Online and Odoo.sh) uses the debian/ubuntu installation method ? Not mandatory though

AntoineVDV · 2021-12-14T12:53:58Z

@AntoineVDV I splitted the installation of Python dependencies into debian/Ubuntu and The pip way. I hope that it will not bring more confusion in the chaos... And I'm not sure that @amigrave will agree

No, I'm ok with that. I'll link from the Odoo.sh FAQ to the "preferred way" of installation. Maybe mention that the Odoo platforms (Odoo Online and Odoo.sh) uses the debian/ubuntu installation method ? Not mandatory though

I don't think that it adds any value from the POV of the doc.

AntoineVDV

I took the liberty to make some fine-tuning changes:

RST cleanup.
Some wording fixes.
Removed the sentence "In that case, the requirements.txt file can be used to install the dependencies." from the virtualenv tip as I believe it's a leftover from when you didn't want to suggest pip anymore.
The wkhtmltopdf warning block didn't make sense anymore, I replaced it by a bullet point.

I believe that it's clear enough to be merged but maybe @jcs-odoo wants to do a last pass? Otherwise,
@robodoo delegate=jcs-odoo

AntoineVDV · 2021-12-14T13:05:38Z

@d-fence I just noticed two changes that I'm not too sure about:

You replaced pip3 with pip in command blocks. Does pip correctly refer to pip3 on the version of Debian/Ubuntu that we support? Because it was not the case before and users had to figure that pip3 was the correct command to call.
You removed pip3 install setuptools wheel which I had to add at some point because these packages were not pre-installed with pip on the brand new Linux Mint machines of our newbies. Is this no longer a problem?

d-fence · 2021-12-14T13:34:39Z

@d-fence I just noticed two changes that I'm not too sure about:

You replaced pip3 with pip in command blocks. Does pip correctly refer to pip3 on the version of Debian/Ubuntu that we support? Because it was not the case before and users had to figure that pip3 was the correct command to call.

AFAIK, Buster and Focal only provides python3-pip where pip and pip3 are the same.

You removed pip3 install setuptools wheel which I had to add at some point because these packages were not pre-installed with pip on the brand new Linux Mint machines of our newbies. Is this no longer a problem?

In the required libraries, we now ask to install python3-pip which depends and recommends all the necessary packages (setuptools, build-essential ...). And we provide a Mint based on Focal AFAIK.

jcs-odoo · 2021-12-15T16:23:24Z

I took the liberty to make some fine-tuning changes:

RST cleanup.

Some wording fixes.

Removed the sentence "In that case, the requirements.txt file can be used to install the dependencies." from the virtualenv tip as I believe it's a leftover from when you didn't want to suggest pip anymore.

The wkhtmltopdf warning block didn't make sense anymore, I replaced it by a bullet point.

I believe that it's clear enough to be merged but maybe @jcs-odoo wants to do a last pass? Otherwise, @robodoo delegate=jcs-odoo

I'm adding a few small fixes then it's good to go.

content/administration/install/install.rst

This commit changes the way that Odoo python dependencies should be installed. Before this commit, the described way to install Odoo dependencies was by using the `pip` utility. Now, we explicitly recommend to use a Debian based system and install Odoo dependencies from their packaging tool. The main reasons are: * Odoo productions instances are, most of the time, run on Debian based systems with those package already installed * That way, a developer cannot mistakenly use a feature from a dependency that does not exists on those production environments * Avoid mixes of python packages on the developer/user 's system

jcs-odoo · 2021-12-17T12:28:02Z

@robodoo r+

This commit changes the way that Odoo python dependencies should be installed. Before this commit, the described way to install Odoo dependencies was by using the `pip` utility. Now, we explicitly recommend to use a Debian based system and install Odoo dependencies from their packaging tool. The main reasons are: * Odoo productions instances are, most of the time, run on Debian based systems with those package already installed * That way, a developer cannot mistakenly use a feature from a dependency that does not exists on those production environments * Avoid mixes of python packages on the developer/user 's system closes #1364 Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>

d-fence requested review from AntoineVDV and amigrave December 8, 2021 10:51

Xavier-Do reviewed Dec 8, 2021

View reviewed changes

amigrave reviewed Dec 8, 2021

View reviewed changes

content/administration/install/install.rst Outdated Show resolved Hide resolved

C3POdoo requested review from a team December 9, 2021 11:00

d-fence force-pushed the master-install-from-apt-moc branch from ff0e329 to de702c1 Compare December 10, 2021 09:09

AntoineVDV requested changes Dec 10, 2021

View reviewed changes

d-fence force-pushed the master-install-from-apt-moc branch from de702c1 to f8a83c4 Compare December 14, 2021 08:45

amigrave mentioned this pull request Dec 14, 2021

[ADD] odoo_sh: Mention Python dependency behavior in FAQ #1329

Closed

d-fence force-pushed the master-install-from-apt-moc branch from f8a83c4 to 94e69d0 Compare December 14, 2021 10:12

AntoineVDV force-pushed the master-install-from-apt-moc branch 2 times, most recently from 47e2f77 to ba81ba0 Compare December 14, 2021 12:31

AntoineVDV force-pushed the master-install-from-apt-moc branch from ba81ba0 to 867d1ff Compare December 14, 2021 12:55

AntoineVDV approved these changes Dec 14, 2021

View reviewed changes

AntoineVDV force-pushed the master-install-from-apt-moc branch from 867d1ff to ffd1584 Compare December 14, 2021 13:00

jcs-odoo reviewed Dec 17, 2021

View reviewed changes

content/administration/install/install.rst Outdated Show resolved Hide resolved

jcs-odoo force-pushed the master-install-from-apt-moc branch from 33d6c69 to 6ab0d55 Compare December 17, 2021 12:22

robodoo closed this Dec 17, 2021

robodoo temporarily deployed to merge December 17, 2021 12:34 Inactive

robodoo added the 15.2 label Dec 17, 2021

fw-bot deleted the master-install-from-apt-moc branch December 31, 2021 12:47

	In that case, the `requirements.txt` file can be used to install the dependencies.
	In that case, the :file:`requirements.txt` file can be used to install the dependencies.

[IMP] install/setup: install dependencies from debian packages #1364

[IMP] install/setup: install dependencies from debian packages #1364

Uh oh!

Conversation

d-fence commented Dec 8, 2021

Uh oh!

robodoo commented Dec 8, 2021

Uh oh!

Xavier-Do Dec 8, 2021

Choose a reason for hiding this comment

Uh oh!

d-fence Dec 8, 2021

Choose a reason for hiding this comment

Uh oh!

d-fence commented Dec 8, 2021

Uh oh!

amigrave left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AntoineVDV left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AntoineVDV Dec 10, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

d-fence commented Dec 14, 2021

Uh oh!

amigrave commented Dec 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AntoineVDV commented Dec 14, 2021

Uh oh!

AntoineVDV left a comment

Choose a reason for hiding this comment

Uh oh!

AntoineVDV commented Dec 14, 2021

Uh oh!

d-fence commented Dec 14, 2021

Uh oh!

jcs-odoo commented Dec 15, 2021

Uh oh!

Uh oh!

jcs-odoo commented Dec 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

amigrave commented Dec 14, 2021 •

edited

Loading