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

Try acsoo --help.

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

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

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

Initialize a new project

mkdir project-dir
cd project-dir
mkvirtualenv project-dir -a .
pip install git+https://github.com/acsone/acsoo.git
mrbob acsoo:templates/project

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.python.org/pypi/pipdeptree, although I don’t think acsoo should depend on that, as it’s only a thin wrapper around the pip api.

acsoo version

A helper to bump version in acsoo.cfg and also bump version in (some?) odoo addons, such as the main addon that pulls dependencies. Requires further thinking.

Maintainer

ACSONE SA/NV

This project is maintained by ACSONE SA/NV.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
acsoo-1.0.1-py2-none-any.whl (39.8 kB) Copy SHA256 hash SHA256 Wheel py2
acsoo-1.0.1.tar.gz (40.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page