Contributors mailing list archives

contributors@odoo-community.org

Re: OCA Coding Standards and recommended IDEs

by
Vauxoo, Nhomar Hernández
- 16/10/2015 19:42:32
Hello Oleg.

Actually we have a huge job already done around a python package which include a huge set of tools IDE's agnostic, which you can include in your decided IDE as a normal python tool (like Flake8 or Pylint config files).

Recommend a tool is not correct, due to this is so so subjective and it do not add any value by itself whta really add value is the fact that you can improve such mqt project proposeing solutions with issues found in such IDES (but those solutions should be proposed without brake any actual feature with another tool).

The best technical way is think as "a python package" and not as a "plugin for X IDE", then if you want develop a plugin for the tool you use which use the features on mqt, then cool! we can considere have such project, BUT taking care that the python package is aways who makes the job.

In our team we have people that use several different IDE, by myself I use VIM and pycharm and tried sublime but we have a lot of others, ninja-ide is other very good one, gedit, etc, etc, etc....

The only way to think to benefit to everybody, is think pythonistic. "Program Once and very good ;-)"

Regards.




On Fri, Oct 16, 2015 at 5:37 AM, Oleg Kuryan <oleg.kuryan@xpansa.com> wrote:
Dear Contributors,

I would like to bring up discussion about coding standards and also recommended for developers IDEs. 
1. Regarding coding standards that is already well described here https://github.com/OCA/maintainer-tools/blob/master/CONTRIBUTING.md 
2. Additionally I would like to suggest to OCA to standardized development environment. Of course, not to force everybody to work in some particular IDEs, but define list of supporting one. So my recommendations for IDEs based on experience in my company are:
- PyCharm
- Sublime Text

Note that point 2 also requires development of standard helper configuration for IDE/Editors validator. And most likely snippets. 
Fr example, for Sublime there is plugin https://github.com/dreadatour/Flake8Lint that adds pep8 validator. And also for snippets there is https://github.com/sotogarcia/sublime-odoo-snippets 

How about creating OCA forks that will help developers to quickly install necessary addons to one of supported editors and start writing code according to standards? Are there already plans on doing this or some work in progress?




--
Nhomar Hernandez
CEO Vauxoo.
Twitter: @nhomar
Odoo Gold Partner
Móvil Venezuela:
+58 4144110269
Móvil México:
+52 1 4773933942