OCA / odoo-module-migrator

Python library to migrate odoo base code from a version to another
GNU Affero General Public License v3.0
123 stars 112 forks source link

[RFC] renaming the library #9

Closed legalsylvain closed 4 years ago

legalsylvain commented 4 years ago

Ref of the thread :

https://odoo-community.org/groups/contributors-15/contributors-147949?mode=thread&date_begin=&date_end=

@pedrobaeza said :

I think we can move it to OCA, but a better name would be odoo-oca-module-migrator, as it avoids confusion with the migration process through OpenUpgrade or similar, and it also ties it to OCA specific process.

My Point of view : OK to rename the lib. I'd prefer odoo-module-migrator because I'm not sure that adding oca is great, because this lib can be used for any modules. (not only OCA modules). But not a blocking point for my side.

Should i rename also the command ?

for the time being the installation is

pip install odoo-migrate

and the command is

odoo-migrate args....

thanks for your answers.

blaggacao commented 4 years ago

odoo-code-transformer ? It's what it does. (ok, it migrates, but ultimately it transforms code in the workdir)

Or others would probably identify it by odoo-refactor -it's a little more specific: code transformation with the goal to comply with new standards. And it's a little less than migration.

legalsylvain commented 4 years ago

@blaggacao : :-1: the objective of this lib is : make automatic changes due to migrations (+ log warning if it's not possible to make it automatically). In that context, changing migrator by transformer or refactor is confusing and is out of the scope of this lib.

Thanks.

blaggacao commented 4 years ago

Yea but, strictly, it does not "migrate", because "migrate" - in a sense might be unspecific and referring to db migration as well... So maybe odoo-code-migrator?

blaggacao commented 4 years ago

Another thought: The main target is to conform code to a specific odoo version (within the OCA context), so maybe odoo-conformer / odoo-comform --to-version 12.0

Maybe the from version can be omitted? (implied)

descriptive naming rather than procedural naming...

Just ideas ... ;-)

blaggacao commented 4 years ago

or even odoo-conform --without-oca --to-version 12.0 ...

pedrobaeza commented 4 years ago

@legalsylvain I talked about oca because some processes are very tied with OCA procedures and guidelines.

legalsylvain commented 4 years ago

OK for odoo-oca-module-migrator. Do i have to rename also the command ? CC : @lmignon : for your git aggregate lib :

the name for the installation is pip install git-aggregator

but the command is gitaggregate.

Is there any python convention / guideline ?

lmignon commented 4 years ago

@legalsylvain I prefre to keep odoo-module-migrator I use it to migrate all my addons (not only those from OCA). IMO odoo-oca-module-migrator give the idea that the script is designed to migrate OCA modules only.

but the command is gitaggregate.

IMO the name of a command should reflect the action that will be taken.

pedrobaeza commented 4 years ago

Although we use it for our own modules migration, it's still applying OCA guidelines and methods, so I still think the oca word should be there.

rousseldenis commented 4 years ago

@pedrobaeza IMHO, oca string should not be a requirement. I think at least we would have licensing comment in the setup and/or README.

legalsylvain commented 4 years ago

Hi all.

I just renamed the project into odoo-module-migrator

@all current users : I don't know exactly what is the impact of a rename of project. maybe you should git clone again the project, of update the git remotes.

CC : @rousseldenis, @lmignon

kind regards.

legalsylvain commented 4 years ago

Note I will also rename the command from odoo-migrate to odoo-module-migrate.

lmignon commented 4 years ago

Thank you @legalsylvain

blaggacao commented 4 years ago

a-thing-with-a-hat-and-a-green-knob It's a knob, but it's red. :wink: sorry the sarcasm, it's not the end of the world either so take it with a grain of salt. :smile:

Thanks for this library!