Skip to main content

Acsone Odoo Dev Tools

Project description

License: GPL-3 https://badge.fury.io/py/acsoo.svg https://travis-ci.org/acsone/acsoo.svg?branch=master https://codecov.io/gh/acsone/acsoo/branch/master/graph/badge.svg

This is a set of command-line utilities to facilitate the Odoo development workflow at Acsone.

It assumes the project is a setuptools-based python package that can be packaged and installed with pip.

Criteria for tools to be included here:

  • being small wrappers around standard commands (git, pip, etc)

  • yet being sufficiently non-trivial to be error-prone or time consuming when done manually

  • being used across several Acsone Odoo projects

Installation

pip install acsoo

To enable bash completion, add this line in your .bashrc:

eval "$(_ACSOO_COMPLETE=source acsoo)"

What we have here

Below, the list of available commands with a few examples.

Use acsoo --help or acsoo <command> --help for more information.

Initialize a new project

mrbob acsoo:templates/project
cd {project name}
mkvirtualenv {project name} -a .

acsoo tag

Tag the current project after ensuring everything has been commited to git.

acsoo tag_editable_requirements

Tag all editable requirements found in requirements.txt, so the referenced commits are not lost in case of git garbage collection.

acsoo wheel

Build wheels for all dependencies found in requirements.txt, plus the project in the current directory.

This is actually almost trivial (ie pip wheel -r requirements.txt -e .), but works around a pip quirk.

acsoo release

Perform acsoo tag, acsoo tag_editable_requirements and acsoo wheel in one command.

acsoo flake8

Run flake8 with sensible default for Odoo code.

It is possible to pass additional options to the flake8 command, eg:

acsoo flake8 -- --ignore E24,W504

acsoo pylint

Run pylint on the odoo or odoo_addons namespace. It automatically uses the pylint-odoo plugin and runs with a reasonable configuration, including an opinionated set of disabled message.

It is possible to pass additional options to the pylint command, eg:

acsoo pylint -- --disable missing-final-newline odoo

This command returns an non-zero exit code if any message is reported. It is however possibly to display messages while reporting success, eg:

acsoo pylint --expected api-one-deprecated:2,line-too-long -- odoo

The above command succeeds despite having exactly 2 api-one-deprecated or any number of line-too-long messages being reported.

It is also possible to force failure on messages that are expected in the default configuration, eg to fail on fixme errors, just expect 0 fixme messages, like this:

acsoo pylint --expected fixme:0 -- odoo

acsoo addons

A set of commands to print addons lists, useful when running tests.

acsoo addons list
acsoo addons list-depends

acsoo checklog

Check if an odoo log file contains error, with the possibility to ignore some errors based on regular expressions.

acsoo checklog odoo.log
odoo -d mydb -i base --stop-after-init | acsoo checklog
acsoo checklog --ignore "WARNING.*blah" odoo.log

bumpversion

Bumpversion is a software automatically installed with acsoo. It allows you to increment or simply change the version of the project in several files at once, including acsoo.cfg.

bumpversion {part}

Where part is ‘major’, ‘minor’ or ‘patch’ (see semantic versioning).

Configure bumpversion by editing the .bumpversion.cfg config file at the root of your project. See the bumpversion documentation to go further (automatic commit, tag, customisation…).

Ideas

acsoo freeze

pip freeze (which works very well as is) with the following additions

  • exluding some common dev tools that are not required in production (pudb, ipdb, acsoo, git-aggregator, setuptools-odoo…) and their dependencies unless such dependencies are required by the project (directly or indirectly).

  • excluding the project itself (as usual for python requirements.txt files)

Inspiration to be found in https://pypi-hypernode.com/pypi/pipdeptree, although I don’t think acsoo should depend on that, as it’s only a thin wrapper around the pip api.

Maintainer

ACSONE SA/NV

This project is maintained by ACSONE SA/NV.

Changes

1.3.0 (2017-06-04)

  • [IMP] flake8: read additional flake8-options in acsoo configuration file.

  • [IMP] template: series-dependent odoo command in .gitlab.ci.yml.

  • [IMP] template: createdb in .gitlab-ci.yml because in 8 Odoo does not do it by itself.

  • [ADD] addons list-depends: –exclude option

1.2.2 (2017-05-30)

  • [FIX] regression in tag, tag_editable_requirements and release commands.

1.2.1 (2017-05-27)

  • [IMP] add possibility to provide main config file as option.

  • [IMP] checklog: read default options from [checklog] section of config file.

  • [IMP] pylint: read default options from [pylint] section of config file.

  • [IMP] pylint: the module or package to lint may be provided with -m.

  • [IMP] flake8: read default options from [flake8] section of config file. The only option so far is config to provide an alternate flake8 configuration file. This is useful so developer only need to type acsoo flake8 locally, even when a specific configuration is needed, so it’s trivial to run locally with the same config as in CI.

1.1.0 (2017-05-25)

  • [IMP] pylint: BREAKING the package to test must be provided explicitly, as soon as additional pylint options are provided, so as to enable easy local testing of a subset of a project. Examples: acsoo pylint -- -d some-message odoo, acsoo pylint -- odoo.addons.xyz;

  • [IMP] pylint: disable more code complexity errors: too-many-nested-blocks, too-many-return-statements.

  • [IMP] pylint: display messages causing failure last, so emails from CI. that show the last lines of the log are more relevant.

  • [IMP] pylint: display summary of messages that did not cause failure, also when there is no failure.

  • [ADD] acsoo addons list and acsoo addons list-depends.

  • [ADD] acsoo checklog.

1.0.1 (2017-05-21)

  • First public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acsoo-1.3.0.tar.gz (50.9 kB view details)

Uploaded Source

Built Distribution

acsoo-1.3.0-py2-none-any.whl (52.1 kB view details)

Uploaded Python 2

File details

Details for the file acsoo-1.3.0.tar.gz.

File metadata

  • Download URL: acsoo-1.3.0.tar.gz
  • Upload date:
  • Size: 50.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for acsoo-1.3.0.tar.gz
Algorithm Hash digest
SHA256 cdb2bb93760798e41ea3c91414b695abf8f431d8efd1b162658262310ce275df
MD5 529ebed350c043f0ace6eaa383ef96bc
BLAKE2b-256 fb7e2ca0a2edb49b116f0f908b232ee4057d14502c893259959758903092ab71

See more details on using hashes here.

File details

Details for the file acsoo-1.3.0-py2-none-any.whl.

File metadata

File hashes

Hashes for acsoo-1.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 3ff7dbbcaf0e7bc41c2ab258ef220e70c7aca0d4d1c76b1d06c52090062d52b2
MD5 d0cb5d9c81b24abd020d0659139bef6a
BLAKE2b-256 0d43cda2f22e77929d83d3d7cb4d354334b72c510708c51f5f39464edd59221d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page