default
4 years ago
commit
3b52532669
35 changed files with 1971 additions and 0 deletions
-
33.copier-answers.yml
-
12.editorconfig
-
180.eslintrc.yml
-
10.flake8
-
29.gitignore
-
12.isort.cfg
-
103.pre-commit-config.yaml
-
7.prettierrc.yml
-
87.pylintrc
-
61.pylintrc-mandatory
-
661LICENSE
-
22README.md
-
33common.yaml
-
162devel.yaml
-
4odoo/.dockerignore
-
2odoo/Dockerfile
-
0odoo/custom/build.d/.empty
-
0odoo/custom/conf.d/.empty
-
0odoo/custom/dependencies/apt.txt
-
0odoo/custom/dependencies/apt_build.txt
-
0odoo/custom/dependencies/gem.txt
-
0odoo/custom/dependencies/npm.txt
-
3odoo/custom/dependencies/pip.txt
-
0odoo/custom/entrypoint.d/.empty
-
0odoo/custom/src/addons.yaml
-
20odoo/custom/src/private/.editorconfig
-
16odoo/custom/src/repos.yaml
-
1odoo/custom/ssh/config
-
0odoo/custom/ssh/id_rsa
-
0odoo/custom/ssh/id_rsa.pub
-
14odoo/custom/ssh/known_hosts
-
37prod.yaml
-
40setup-devel.yaml
-
354tasks.py
-
68test.yaml
@ -0,0 +1,33 @@ |
|||
# Changes here will be overwritten by Copier |
|||
_commit: v2.4.2 |
|||
_src_path: gh:Tecnativa/doodba-copier-template |
|||
backup_deletion: true |
|||
backup_dst: null |
|||
backup_email_from: null |
|||
backup_email_to: null |
|||
backup_tz: UTC |
|||
cidr_whitelist: null |
|||
domains_prod: null |
|||
domains_test: null |
|||
gitlab_url: null |
|||
odoo_dbfilter: .* |
|||
odoo_initial_lang: fr_FR |
|||
odoo_listdb: true |
|||
odoo_oci_image: null |
|||
odoo_proxy: null |
|||
odoo_version: 14.0 |
|||
paths_without_crawlers: |
|||
- /web |
|||
- /website/info |
|||
postgres_dbname: prod |
|||
postgres_username: odoo |
|||
postgres_version: 10 |
|||
project_author: Tecnativa |
|||
project_license: AGPL-3.0-or-later |
|||
project_name: myproject-odoo |
|||
smtp_canonical_default: null |
|||
smtp_canonical_domains: null |
|||
smtp_default_from: null |
|||
smtp_relay_host: null |
|||
smtp_relay_port: 587 |
|||
smtp_relay_user: null |
|||
@ -0,0 +1,12 @@ |
|||
root = true |
|||
|
|||
[*] |
|||
indent_style = space |
|||
indent_size = 4 |
|||
end_of_line = lf |
|||
charset = utf-8 |
|||
trim_trailing_whitespace = true |
|||
insert_final_newline = true |
|||
|
|||
[*.{code-snippets,code-workspace,json,md,yaml,yml}{,.jinja}] |
|||
indent_size = 2 |
|||
@ -0,0 +1,180 @@ |
|||
env: |
|||
browser: true |
|||
|
|||
# See https://github.com/OCA/odoo-community.org/issues/37#issuecomment-470686449 |
|||
parserOptions: |
|||
ecmaVersion: 2017 |
|||
|
|||
# Globals available in Odoo that shouldn't produce errorings |
|||
globals: |
|||
_: readonly |
|||
$: readonly |
|||
fuzzy: readonly |
|||
jQuery: readonly |
|||
moment: readonly |
|||
odoo: readonly |
|||
openerp: readonly |
|||
Promise: readonly |
|||
|
|||
# Styling is handled by Prettier, so we only need to enable AST rules; |
|||
# see https://github.com/OCA/maintainer-quality-tools/pull/618#issuecomment-558576890 |
|||
rules: |
|||
accessor-pairs: warn |
|||
array-callback-return: warn |
|||
callback-return: warn |
|||
capitalized-comments: |
|||
- warn |
|||
- always |
|||
- ignoreConsecutiveComments: true |
|||
ignoreInlineComments: true |
|||
complexity: |
|||
- warn |
|||
- 15 |
|||
constructor-super: warn |
|||
dot-notation: warn |
|||
eqeqeq: warn |
|||
global-require: warn |
|||
handle-callback-err: warn |
|||
id-blacklist: warn |
|||
id-match: warn |
|||
init-declarations: error |
|||
max-depth: warn |
|||
max-nested-callbacks: warn |
|||
max-statements-per-line: warn |
|||
no-alert: warn |
|||
no-array-constructor: warn |
|||
no-caller: warn |
|||
no-case-declarations: warn |
|||
no-class-assign: warn |
|||
no-cond-assign: error |
|||
no-const-assign: error |
|||
no-constant-condition: warn |
|||
no-control-regex: warn |
|||
no-debugger: error |
|||
no-delete-var: warn |
|||
no-div-regex: warn |
|||
no-dupe-args: error |
|||
no-dupe-class-members: error |
|||
no-dupe-keys: error |
|||
no-duplicate-case: error |
|||
no-duplicate-imports: error |
|||
no-else-return: warn |
|||
no-empty-character-class: warn |
|||
no-empty-function: error |
|||
no-empty-pattern: error |
|||
no-empty: warn |
|||
no-eq-null: error |
|||
no-eval: error |
|||
no-ex-assign: error |
|||
no-extend-native: warn |
|||
no-extra-bind: warn |
|||
no-extra-boolean-cast: warn |
|||
no-extra-label: warn |
|||
no-fallthrough: warn |
|||
no-func-assign: error |
|||
no-global-assign: error |
|||
no-implicit-coercion: |
|||
- warn |
|||
- allow: ["~"] |
|||
no-implicit-globals: warn |
|||
no-implied-eval: warn |
|||
no-inline-comments: warn |
|||
no-inner-declarations: warn |
|||
no-invalid-regexp: warn |
|||
no-irregular-whitespace: warn |
|||
no-iterator: warn |
|||
no-label-var: warn |
|||
no-labels: warn |
|||
no-lone-blocks: warn |
|||
no-lonely-if: error |
|||
no-mixed-requires: error |
|||
no-multi-str: warn |
|||
no-native-reassign: error |
|||
no-negated-condition: warn |
|||
no-negated-in-lhs: error |
|||
no-new-func: warn |
|||
no-new-object: warn |
|||
no-new-require: warn |
|||
no-new-symbol: warn |
|||
no-new-wrappers: warn |
|||
no-new: warn |
|||
no-obj-calls: warn |
|||
no-octal-escape: warn |
|||
no-octal: warn |
|||
no-param-reassign: warn |
|||
no-path-concat: warn |
|||
no-process-env: warn |
|||
no-process-exit: warn |
|||
no-proto: warn |
|||
no-prototype-builtins: warn |
|||
no-redeclare: warn |
|||
no-regex-spaces: warn |
|||
no-restricted-globals: warn |
|||
no-restricted-imports: warn |
|||
no-restricted-modules: warn |
|||
no-restricted-syntax: warn |
|||
no-return-assign: error |
|||
no-script-url: warn |
|||
no-self-assign: warn |
|||
no-self-compare: warn |
|||
no-sequences: warn |
|||
no-shadow-restricted-names: warn |
|||
no-shadow: warn |
|||
no-sparse-arrays: warn |
|||
no-sync: warn |
|||
no-this-before-super: warn |
|||
no-throw-literal: warn |
|||
no-undef-init: warn |
|||
no-undef: error |
|||
no-unmodified-loop-condition: warn |
|||
no-unneeded-ternary: error |
|||
no-unreachable: error |
|||
no-unsafe-finally: error |
|||
no-unused-expressions: error |
|||
no-unused-labels: error |
|||
no-unused-vars: error |
|||
no-use-before-define: error |
|||
no-useless-call: warn |
|||
no-useless-computed-key: warn |
|||
no-useless-concat: warn |
|||
no-useless-constructor: warn |
|||
no-useless-escape: warn |
|||
no-useless-rename: warn |
|||
no-void: warn |
|||
no-with: warn |
|||
operator-assignment: [error, always] |
|||
prefer-const: warn |
|||
radix: warn |
|||
require-yield: warn |
|||
sort-imports: warn |
|||
spaced-comment: [error, always] |
|||
strict: [error, function] |
|||
use-isnan: error |
|||
valid-jsdoc: |
|||
- warn |
|||
- prefer: |
|||
arg: param |
|||
argument: param |
|||
augments: extends |
|||
constructor: class |
|||
exception: throws |
|||
func: function |
|||
method: function |
|||
prop: property |
|||
return: returns |
|||
virtual: abstract |
|||
yield: yields |
|||
preferType: |
|||
array: Array |
|||
bool: Boolean |
|||
boolean: Boolean |
|||
number: Number |
|||
object: Object |
|||
str: String |
|||
string: String |
|||
requireParamDescription: false |
|||
requireReturn: false |
|||
requireReturnDescription: false |
|||
requireReturnType: false |
|||
valid-typeof: warn |
|||
yoda: warn |
|||
@ -0,0 +1,10 @@ |
|||
[flake8] |
|||
max-line-length = 80 |
|||
max-complexity = 16 |
|||
# B = bugbear |
|||
# B9 = bugbear opinionated (incl line length) |
|||
select = C,E,F,W,B,B9 |
|||
# E203: whitespace before ':' (black behaviour) |
|||
# E501: flake8 line length (covered by bugbear B950) |
|||
# W503: line break before binary operator (black behaviour) |
|||
ignore = E203,E501,W503 |
|||
@ -0,0 +1,29 @@ |
|||
# Ignore all src directories except private and files with a dot |
|||
/odoo/auto |
|||
/odoo/custom/src/*/ |
|||
!/odoo/custom/src/private/ |
|||
|
|||
# Ignore docker-compose.yml by default, to allow easy defaults per clone |
|||
/docker-compose.yml |
|||
|
|||
# Compiled formats, cache, temporary files, git garbage |
|||
**.~ |
|||
**.mo |
|||
**.py[co] |
|||
**.egg-info |
|||
**.orig |
|||
|
|||
# User-specific or editor-specific development files and settings |
|||
!/.vscode/*.jinja |
|||
!/.vscode/extensions.json |
|||
!/.vscode/launch.json |
|||
!/.vscode/settings.json |
|||
!/.vscode/tasks.json |
|||
.vscode/* |
|||
/odoo/custom/src/private/.vscode/* |
|||
/.venv |
|||
/doodba.*.code-workspace |
|||
/src |
|||
|
|||
# Project-specific docker configurations |
|||
/.docker/ |
|||
@ -0,0 +1,12 @@ |
|||
[settings] |
|||
; see https://github.com/psf/black |
|||
multi_line_output=3 |
|||
include_trailing_comma=True |
|||
force_grid_wrap=0 |
|||
combine_as_imports=True |
|||
use_parentheses=True |
|||
line_length=88 |
|||
known_odoo=odoo |
|||
known_odoo_addons=odoo.addons |
|||
sections=FUTURE,STDLIB,THIRDPARTY,ODOO,ODOO_ADDONS,FIRSTPARTY,LOCALFOLDER |
|||
default_section=THIRDPARTY |
|||
@ -0,0 +1,103 @@ |
|||
exclude: | |
|||
(?x) |
|||
# Files and folders generated by bots, to avoid loops |
|||
/static/description/index\.html$| |
|||
# Library files can have extraneous formatting (even minimized) |
|||
/static/(src/)?lib/| |
|||
# You don't usually want a bot to modify your legal texts |
|||
(LICENSE.*|COPYING.*) |
|||
default_language_version: |
|||
python: python3 |
|||
node: "14.14.0" |
|||
repos: |
|||
- repo: local |
|||
hooks: |
|||
- id: forbidden-files |
|||
name: forbidden files |
|||
entry: found forbidden files; remove them |
|||
language: fail |
|||
files: "\\.rej$" |
|||
- repo: https://github.com/psf/black |
|||
rev: 20.8b1 |
|||
hooks: |
|||
- id: black |
|||
- repo: https://github.com/asottile/pyupgrade |
|||
rev: v2.7.2 |
|||
hooks: |
|||
- id: pyupgrade |
|||
- repo: https://github.com/timothycrosley/isort |
|||
rev: 5.5.1 |
|||
hooks: |
|||
- id: isort |
|||
name: isort except __init__.py |
|||
args: [--settings, .] |
|||
exclude: /__init__\.py$ |
|||
# TODO Migrate to new prettier pre-commit repo after fixed: |
|||
# HACK https://github.com/prettier/pre-commit/pull/17 |
|||
# HACK https://github.com/prettier/pre-commit/pull/18 |
|||
- repo: https://github.com/prettier/prettier |
|||
rev: 2.1.2 |
|||
hooks: |
|||
- id: prettier |
|||
name: prettier + plugin-xml |
|||
additional_dependencies: |
|||
- "@prettier/plugin-xml@0.12.0" |
|||
args: |
|||
- --plugin=@prettier/plugin-xml |
|||
- repo: https://github.com/pre-commit/pre-commit-hooks |
|||
rev: v3.2.0 |
|||
hooks: |
|||
- id: trailing-whitespace |
|||
- id: end-of-file-fixer |
|||
- id: debug-statements |
|||
- id: fix-encoding-pragma |
|||
args: ["--remove"] |
|||
- id: check-case-conflict |
|||
- id: check-docstring-first |
|||
- id: check-executables-have-shebangs |
|||
- id: check-merge-conflict |
|||
- id: check-symlinks |
|||
- id: check-xml |
|||
- id: mixed-line-ending |
|||
args: ["--fix=lf"] |
|||
- repo: https://gitlab.com/pycqa/flake8 |
|||
rev: 3.8.3 |
|||
hooks: |
|||
- id: flake8 |
|||
name: flake8 except __init__.py |
|||
exclude: /__init__\.py$ |
|||
additional_dependencies: ["flake8-bugbear==20.1.4"] |
|||
- id: flake8 |
|||
name: flake8 only __init__.py |
|||
args: ["--extend-ignore=F401"] # ignore unused imports in __init__.py |
|||
files: /__init__\.py$ |
|||
additional_dependencies: ["flake8-bugbear==20.1.4"] |
|||
- repo: https://github.com/pycqa/pylint |
|||
rev: pylint-2.6.0 |
|||
hooks: |
|||
- id: pylint |
|||
name: pylint with optional checks |
|||
args: |
|||
- --valid_odoo_versions=14.0 |
|||
- --rcfile=.pylintrc |
|||
- --exit-zero |
|||
verbose: true |
|||
additional_dependencies: |
|||
- isort==4.3.21 |
|||
- pylint-odoo==3.5.0 |
|||
- id: pylint |
|||
name: pylint with mandatory checks |
|||
args: |
|||
- --valid_odoo_versions=14.0 |
|||
- --rcfile=.pylintrc-mandatory |
|||
additional_dependencies: |
|||
- isort==4.3.21 |
|||
- pylint-odoo==3.5.0 |
|||
- repo: https://github.com/pre-commit/mirrors-eslint |
|||
rev: v7.8.1 |
|||
hooks: |
|||
- id: eslint |
|||
verbose: true |
|||
args: |
|||
- --color |
|||
- --fix |
|||
@ -0,0 +1,7 @@ |
|||
# Defaults for all prettier-supported languages |
|||
# Prettier will complete this with settings from .editorconfig file. |
|||
bracketSpacing: false |
|||
printWidth: 88 |
|||
proseWrap: always |
|||
semi: true |
|||
trailingComma: "es5" |
|||
@ -0,0 +1,87 @@ |
|||
[MASTER] |
|||
load-plugins=pylint_odoo |
|||
score=n |
|||
|
|||
[ODOOLINT] |
|||
readme_template_url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" |
|||
manifest_required_authors=Tecnativa |
|||
manifest_required_keys=license |
|||
manifest_deprecated_keys=description,active |
|||
license_allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3,OPL-1,OEEL-1 |
|||
valid_odoo_versions=14.0 |
|||
|
|||
[MESSAGES CONTROL] |
|||
disable=all |
|||
|
|||
# This .pylintrc contains optional AND mandatory checks and is meant to be |
|||
# loaded in an IDE to have it check everything, in the hope this will make |
|||
# optional checks more visible to contributors who otherwise never look at a |
|||
# green travis to see optional checks that failed. |
|||
# .pylintrc-mandatory containing only mandatory checks is used the pre-commit |
|||
# config as a blocking check. |
|||
|
|||
enable=anomalous-backslash-in-string, |
|||
api-one-deprecated, |
|||
api-one-multi-together, |
|||
assignment-from-none, |
|||
attribute-deprecated, |
|||
class-camelcase, |
|||
dangerous-default-value, |
|||
dangerous-view-replace-wo-priority, |
|||
duplicate-id-csv, |
|||
duplicate-key, |
|||
duplicate-xml-fields, |
|||
duplicate-xml-record-id, |
|||
eval-referenced, |
|||
eval-used, |
|||
incoherent-interpreter-exec-perm, |
|||
license-allowed, |
|||
manifest-author-string, |
|||
manifest-deprecated-key, |
|||
manifest-required-author, |
|||
manifest-required-key, |
|||
manifest-version-format, |
|||
method-compute, |
|||
method-inverse, |
|||
method-required-super, |
|||
method-search, |
|||
missing-import-error, |
|||
missing-manifest-dependency, |
|||
openerp-exception-warning, |
|||
pointless-statement, |
|||
pointless-string-statement, |
|||
print-used, |
|||
redundant-keyword-arg, |
|||
redundant-modulename-xml, |
|||
reimported, |
|||
relative-import, |
|||
return-in-init, |
|||
rst-syntax-error, |
|||
sql-injection, |
|||
too-few-format-args, |
|||
translation-field, |
|||
translation-required, |
|||
unreachable, |
|||
use-vim-comment, |
|||
wrong-tabs-instead-of-spaces, |
|||
xml-syntax-error, |
|||
# messages that do not cause the lint step to fail |
|||
consider-merging-classes-inherited, |
|||
create-user-wo-reset-password, |
|||
dangerous-filter-wo-user, |
|||
deprecated-module, |
|||
file-not-used, |
|||
invalid-commit, |
|||
missing-newline-extrafiles, |
|||
missing-readme, |
|||
no-utf8-coding-comment, |
|||
odoo-addons-relative-import, |
|||
old-api7-method-defined, |
|||
redefined-builtin, |
|||
too-complex, |
|||
unnecessary-utf8-coding-comment |
|||
|
|||
[REPORTS] |
|||
msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} |
|||
output-format=colorized |
|||
reports=no |
|||
@ -0,0 +1,61 @@ |
|||
[MASTER] |
|||
load-plugins=pylint_odoo |
|||
score=n |
|||
|
|||
[ODOOLINT] |
|||
readme_template_url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" |
|||
manifest_required_keys=license |
|||
manifest_deprecated_keys=active |
|||
valid_odoo_versions=14.0 |
|||
|
|||
[MESSAGES CONTROL] |
|||
disable=all |
|||
|
|||
enable=anomalous-backslash-in-string, |
|||
api-one-deprecated, |
|||
api-one-multi-together, |
|||
assignment-from-none, |
|||
attribute-deprecated, |
|||
class-camelcase, |
|||
dangerous-default-value, |
|||
dangerous-view-replace-wo-priority, |
|||
duplicate-id-csv, |
|||
duplicate-key, |
|||
duplicate-xml-fields, |
|||
duplicate-xml-record-id, |
|||
eval-referenced, |
|||
eval-used, |
|||
incoherent-interpreter-exec-perm, |
|||
manifest-author-string, |
|||
manifest-deprecated-key, |
|||
manifest-required-key, |
|||
manifest-version-format, |
|||
method-compute, |
|||
method-inverse, |
|||
method-required-super, |
|||
method-search, |
|||
missing-import-error, |
|||
missing-manifest-dependency, |
|||
openerp-exception-warning, |
|||
pointless-statement, |
|||
pointless-string-statement, |
|||
print-used, |
|||
redundant-keyword-arg, |
|||
redundant-modulename-xml, |
|||
reimported, |
|||
relative-import, |
|||
return-in-init, |
|||
rst-syntax-error, |
|||
sql-injection, |
|||
too-few-format-args, |
|||
translation-field, |
|||
translation-required, |
|||
unreachable, |
|||
use-vim-comment, |
|||
wrong-tabs-instead-of-spaces, |
|||
xml-syntax-error |
|||
|
|||
[REPORTS] |
|||
msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} |
|||
output-format=colorized |
|||
reports=no |
|||
@ -0,0 +1,661 @@ |
|||
GNU AFFERO GENERAL PUBLIC LICENSE |
|||
Version 3, 19 November 2007 |
|||
|
|||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
|||
Everyone is permitted to copy and distribute verbatim copies |
|||
of this license document, but changing it is not allowed. |
|||
|
|||
Preamble |
|||
|
|||
The GNU Affero General Public License is a free, copyleft license for |
|||
software and other kinds of works, specifically designed to ensure |
|||
cooperation with the community in the case of network server software. |
|||
|
|||
The licenses for most software and other practical works are designed |
|||
to take away your freedom to share and change the works. By contrast, |
|||
our General Public Licenses are intended to guarantee your freedom to |
|||
share and change all versions of a program--to make sure it remains free |
|||
software for all its users. |
|||
|
|||
When we speak of free software, we are referring to freedom, not |
|||
price. Our General Public Licenses are designed to make sure that you |
|||
have the freedom to distribute copies of free software (and charge for |
|||
them if you wish), that you receive source code or can get it if you |
|||
want it, that you can change the software or use pieces of it in new |
|||
free programs, and that you know you can do these things. |
|||
|
|||
Developers that use our General Public Licenses protect your rights |
|||
with two steps: (1) assert copyright on the software, and (2) offer |
|||
you this License which gives you legal permission to copy, distribute |
|||
and/or modify the software. |
|||
|
|||
A secondary benefit of defending all users' freedom is that |
|||
improvements made in alternate versions of the program, if they |
|||
receive widespread use, become available for other developers to |
|||
incorporate. Many developers of free software are heartened and |
|||
encouraged by the resulting cooperation. However, in the case of |
|||
software used on network servers, this result may fail to come about. |
|||
The GNU General Public License permits making a modified version and |
|||
letting the public access it on a server without ever releasing its |
|||
source code to the public. |
|||
|
|||
The GNU Affero General Public License is designed specifically to |
|||
ensure that, in such cases, the modified source code becomes available |
|||
to the community. It requires the operator of a network server to |
|||
provide the source code of the modified version running there to the |
|||
users of that server. Therefore, public use of a modified version, on |
|||
a publicly accessible server, gives the public access to the source |
|||
code of the modified version. |
|||
|
|||
An older license, called the Affero General Public License and |
|||
published by Affero, was designed to accomplish similar goals. This is |
|||
a different license, not a version of the Affero GPL, but Affero has |
|||
released a new version of the Affero GPL which permits relicensing under |
|||
this license. |
|||
|
|||
The precise terms and conditions for copying, distribution and |
|||
modification follow. |
|||
|
|||
TERMS AND CONDITIONS |
|||
|
|||
0. Definitions. |
|||
|
|||
"This License" refers to version 3 of the GNU Affero General Public License. |
|||
|
|||
"Copyright" also means copyright-like laws that apply to other kinds of |
|||
works, such as semiconductor masks. |
|||
|
|||
"The Program" refers to any copyrightable work licensed under this |
|||
License. Each licensee is addressed as "you". "Licensees" and |
|||
"recipients" may be individuals or organizations. |
|||
|
|||
To "modify" a work means to copy from or adapt all or part of the work |
|||
in a fashion requiring copyright permission, other than the making of an |
|||
exact copy. The resulting work is called a "modified version" of the |
|||
earlier work or a work "based on" the earlier work. |
|||
|
|||
A "covered work" means either the unmodified Program or a work based |
|||
on the Program. |
|||
|
|||
To "propagate" a work means to do anything with it that, without |
|||
permission, would make you directly or secondarily liable for |
|||
infringement under applicable copyright law, except executing it on a |
|||
computer or modifying a private copy. Propagation includes copying, |
|||
distribution (with or without modification), making available to the |
|||
public, and in some countries other activities as well. |
|||
|
|||
To "convey" a work means any kind of propagation that enables other |
|||
parties to make or receive copies. Mere interaction with a user through |
|||
a computer network, with no transfer of a copy, is not conveying. |
|||
|
|||
An interactive user interface displays "Appropriate Legal Notices" |
|||
to the extent that it includes a convenient and prominently visible |
|||
feature that (1) displays an appropriate copyright notice, and (2) |
|||
tells the user that there is no warranty for the work (except to the |
|||
extent that warranties are provided), that licensees may convey the |
|||
work under this License, and how to view a copy of this License. If |
|||
the interface presents a list of user commands or options, such as a |
|||
menu, a prominent item in the list meets this criterion. |
|||
|
|||
1. Source Code. |
|||
|
|||
The "source code" for a work means the preferred form of the work |
|||
for making modifications to it. "Object code" means any non-source |
|||
form of a work. |
|||
|
|||
A "Standard Interface" means an interface that either is an official |
|||
standard defined by a recognized standards body, or, in the case of |
|||
interfaces specified for a particular programming language, one that |
|||
is widely used among developers working in that language. |
|||
|
|||
The "System Libraries" of an executable work include anything, other |
|||
than the work as a whole, that (a) is included in the normal form of |
|||
packaging a Major Component, but which is not part of that Major |
|||
Component, and (b) serves only to enable use of the work with that |
|||
Major Component, or to implement a Standard Interface for which an |
|||
implementation is available to the public in source code form. A |
|||
"Major Component", in this context, means a major essential component |
|||
(kernel, window system, and so on) of the specific operating system |
|||
(if any) on which the executable work runs, or a compiler used to |
|||
produce the work, or an object code interpreter used to run it. |
|||
|
|||
The "Corresponding Source" for a work in object code form means all |
|||
the source code needed to generate, install, and (for an executable |
|||
work) run the object code and to modify the work, including scripts to |
|||
control those activities. However, it does not include the work's |
|||
System Libraries, or general-purpose tools or generally available free |
|||
programs which are used unmodified in performing those activities but |
|||
which are not part of the work. For example, Corresponding Source |
|||
includes interface definition files associated with source files for |
|||
the work, and the source code for shared libraries and dynamically |
|||
linked subprograms that the work is specifically designed to require, |
|||
such as by intimate data communication or control flow between those |
|||
subprograms and other parts of the work. |
|||
|
|||
The Corresponding Source need not include anything that users |
|||
can regenerate automatically from other parts of the Corresponding |
|||
Source. |
|||
|
|||
The Corresponding Source for a work in source code form is that |
|||
same work. |
|||
|
|||
2. Basic Permissions. |
|||
|
|||
All rights granted under this License are granted for the term of |
|||
copyright on the Program, and are irrevocable provided the stated |
|||
conditions are met. This License explicitly affirms your unlimited |
|||
permission to run the unmodified Program. The output from running a |
|||
covered work is covered by this License only if the output, given its |
|||
content, constitutes a covered work. This License acknowledges your |
|||
rights of fair use or other equivalent, as provided by copyright law. |
|||
|
|||
You may make, run and propagate covered works that you do not |
|||
convey, without conditions so long as your license otherwise remains |
|||
in force. You may convey covered works to others for the sole purpose |
|||
of having them make modifications exclusively for you, or provide you |
|||
with facilities for running those works, provided that you comply with |
|||
the terms of this License in conveying all material for which you do |
|||
not control copyright. Those thus making or running the covered works |
|||
for you must do so exclusively on your behalf, under your direction |
|||
and control, on terms that prohibit them from making any copies of |
|||
your copyrighted material outside their relationship with you. |
|||
|
|||
Conveying under any other circumstances is permitted solely under |
|||
the conditions stated below. Sublicensing is not allowed; section 10 |
|||
makes it unnecessary. |
|||
|
|||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
|||
|
|||
No covered work shall be deemed part of an effective technological |
|||
measure under any applicable law fulfilling obligations under article |
|||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
|||
similar laws prohibiting or restricting circumvention of such |
|||
measures. |
|||
|
|||
When you convey a covered work, you waive any legal power to forbid |
|||
circumvention of technological measures to the extent such circumvention |
|||
is effected by exercising rights under this License with respect to |
|||
the covered work, and you disclaim any intention to limit operation or |
|||
modification of the work as a means of enforcing, against the work's |
|||
users, your or third parties' legal rights to forbid circumvention of |
|||
technological measures. |
|||
|
|||
4. Conveying Verbatim Copies. |
|||
|
|||
You may convey verbatim copies of the Program's source code as you |
|||
receive it, in any medium, provided that you conspicuously and |
|||
appropriately publish on each copy an appropriate copyright notice; |
|||
keep intact all notices stating that this License and any |
|||
non-permissive terms added in accord with section 7 apply to the code; |
|||
keep intact all notices of the absence of any warranty; and give all |
|||
recipients a copy of this License along with the Program. |
|||
|
|||
You may charge any price or no price for each copy that you convey, |
|||
and you may offer support or warranty protection for a fee. |
|||
|
|||
5. Conveying Modified Source Versions. |
|||
|
|||
You may convey a work based on the Program, or the modifications to |
|||
produce it from the Program, in the form of source code under the |
|||
terms of section 4, provided that you also meet all of these conditions: |
|||
|
|||
a) The work must carry prominent notices stating that you modified |
|||
it, and giving a relevant date. |
|||
|
|||
b) The work must carry prominent notices stating that it is |
|||
released under this License and any conditions added under section |
|||
7. This requirement modifies the requirement in section 4 to |
|||
"keep intact all notices". |
|||
|
|||
c) You must license the entire work, as a whole, under this |
|||
License to anyone who comes into possession of a copy. This |
|||
License will therefore apply, along with any applicable section 7 |
|||
additional terms, to the whole of the work, and all its parts, |
|||
regardless of how they are packaged. This License gives no |
|||
permission to license the work in any other way, but it does not |
|||
invalidate such permission if you have separately received it. |
|||
|
|||
d) If the work has interactive user interfaces, each must display |
|||
Appropriate Legal Notices; however, if the Program has interactive |
|||
interfaces that do not display Appropriate Legal Notices, your |
|||
work need not make them do so. |
|||
|
|||
A compilation of a covered work with other separate and independent |
|||
works, which are not by their nature extensions of the covered work, |
|||
and which are not combined with it such as to form a larger program, |
|||
in or on a volume of a storage or distribution medium, is called an |
|||
"aggregate" if the compilation and its resulting copyright are not |
|||
used to limit the access or legal rights of the compilation's users |
|||
beyond what the individual works permit. Inclusion of a covered work |
|||
in an aggregate does not cause this License to apply to the other |
|||
parts of the aggregate. |
|||
|
|||
6. Conveying Non-Source Forms. |
|||
|
|||
You may convey a covered work in object code form under the terms |
|||
of sections 4 and 5, provided that you also convey the |
|||
machine-readable Corresponding Source under the terms of this License, |
|||
in one of these ways: |
|||
|
|||
a) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by the |
|||
Corresponding Source fixed on a durable physical medium |
|||
customarily used for software interchange. |
|||
|
|||
b) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by a |
|||
written offer, valid for at least three years and valid for as |
|||
long as you offer spare parts or customer support for that product |
|||
model, to give anyone who possesses the object code either (1) a |
|||
copy of the Corresponding Source for all the software in the |
|||
product that is covered by this License, on a durable physical |
|||
medium customarily used for software interchange, for a price no |
|||
more than your reasonable cost of physically performing this |
|||
conveying of source, or (2) access to copy the |
|||
Corresponding Source from a network server at no charge. |
|||
|
|||
c) Convey individual copies of the object code with a copy of the |
|||
written offer to provide the Corresponding Source. This |
|||
alternative is allowed only occasionally and noncommercially, and |
|||
only if you received the object code with such an offer, in accord |
|||
with subsection 6b. |
|||
|
|||
d) Convey the object code by offering access from a designated |
|||
place (gratis or for a charge), and offer equivalent access to the |
|||
Corresponding Source in the same way through the same place at no |
|||
further charge. You need not require recipients to copy the |
|||
Corresponding Source along with the object code. If the place to |
|||
copy the object code is a network server, the Corresponding Source |
|||
may be on a different server (operated by you or a third party) |
|||
that supports equivalent copying facilities, provided you maintain |
|||
clear directions next to the object code saying where to find the |
|||
Corresponding Source. Regardless of what server hosts the |
|||
Corresponding Source, you remain obligated to ensure that it is |
|||
available for as long as needed to satisfy these requirements. |
|||
|
|||
e) Convey the object code using peer-to-peer transmission, provided |
|||
you inform other peers where the object code and Corresponding |
|||
Source of the work are being offered to the general public at no |
|||
charge under subsection 6d. |
|||
|
|||
A separable portion of the object code, whose source code is excluded |
|||
from the Corresponding Source as a System Library, need not be |
|||
included in conveying the object code work. |
|||
|
|||
A "User Product" is either (1) a "consumer product", which means any |
|||
tangible personal property which is normally used for personal, family, |
|||
or household purposes, or (2) anything designed or sold for incorporation |
|||
into a dwelling. In determining whether a product is a consumer product, |
|||
doubtful cases shall be resolved in favor of coverage. For a particular |
|||
product received by a particular user, "normally used" refers to a |
|||
typical or common use of that class of product, regardless of the status |
|||
of the particular user or of the way in which the particular user |
|||
actually uses, or expects or is expected to use, the product. A product |
|||
is a consumer product regardless of whether the product has substantial |
|||
commercial, industrial or non-consumer uses, unless such uses represent |
|||
the only significant mode of use of the product. |
|||
|
|||
"Installation Information" for a User Product means any methods, |
|||
procedures, authorization keys, or other information required to install |
|||
and execute modified versions of a covered work in that User Product from |
|||
a modified version of its Corresponding Source. The information must |
|||
suffice to ensure that the continued functioning of the modified object |
|||
code is in no case prevented or interfered with solely because |
|||
modification has been made. |
|||
|
|||
If you convey an object code work under this section in, or with, or |
|||
specifically for use in, a User Product, and the conveying occurs as |
|||
part of a transaction in which the right of possession and use of the |
|||
User Product is transferred to the recipient in perpetuity or for a |
|||
fixed term (regardless of how the transaction is characterized), the |
|||
Corresponding Source conveyed under this section must be accompanied |
|||
by the Installation Information. But this requirement does not apply |
|||
if neither you nor any third party retains the ability to install |
|||
modified object code on the User Product (for example, the work has |
|||
been installed in ROM). |
|||
|
|||
The requirement to provide Installation Information does not include a |
|||
requirement to continue to provide support service, warranty, or updates |
|||
for a work that has been modified or installed by the recipient, or for |
|||
the User Product in which it has been modified or installed. Access to a |
|||
network may be denied when the modification itself materially and |
|||
adversely affects the operation of the network or violates the rules and |
|||
protocols for communication across the network. |
|||
|
|||
Corresponding Source conveyed, and Installation Information provided, |
|||
in accord with this section must be in a format that is publicly |
|||
documented (and with an implementation available to the public in |
|||
source code form), and must require no special password or key for |
|||
unpacking, reading or copying. |
|||
|
|||
7. Additional Terms. |
|||
|
|||
"Additional permissions" are terms that supplement the terms of this |
|||
License by making exceptions from one or more of its conditions. |
|||
Additional permissions that are applicable to the entire Program shall |
|||
be treated as though they were included in this License, to the extent |
|||
that they are valid under applicable law. If additional permissions |
|||
apply only to part of the Program, that part may be used separately |
|||
under those permissions, but the entire Program remains governed by |
|||
this License without regard to the additional permissions. |
|||
|
|||
When you convey a copy of a covered work, you may at your option |
|||
remove any additional permissions from that copy, or from any part of |
|||
it. (Additional permissions may be written to require their own |
|||
removal in certain cases when you modify the work.) You may place |
|||
additional permissions on material, added by you to a covered work, |
|||
for which you have or can give appropriate copyright permission. |
|||
|
|||
Notwithstanding any other provision of this License, for material you |
|||
add to a covered work, you may (if authorized by the copyright holders of |
|||
that material) supplement the terms of this License with terms: |
|||
|
|||
a) Disclaiming warranty or limiting liability differently from the |
|||
terms of sections 15 and 16 of this License; or |
|||
|
|||
b) Requiring preservation of specified reasonable legal notices or |
|||
author attributions in that material or in the Appropriate Legal |
|||
Notices displayed by works containing it; or |
|||
|
|||
c) Prohibiting misrepresentation of the origin of that material, or |
|||
requiring that modified versions of such material be marked in |
|||
reasonable ways as different from the original version; or |
|||
|
|||
d) Limiting the use for publicity purposes of names of licensors or |
|||
authors of the material; or |
|||
|
|||
e) Declining to grant rights under trademark law for use of some |
|||
trade names, trademarks, or service marks; or |
|||
|
|||
f) Requiring indemnification of licensors and authors of that |
|||
material by anyone who conveys the material (or modified versions of |
|||
it) with contractual assumptions of liability to the recipient, for |
|||
any liability that these contractual assumptions directly impose on |
|||
those licensors and authors. |
|||
|
|||
All other non-permissive additional terms are considered "further |
|||
restrictions" within the meaning of section 10. If the Program as you |
|||
received it, or any part of it, contains a notice stating that it is |
|||
governed by this License along with a term that is a further |
|||
restriction, you may remove that term. If a license document contains |
|||
a further restriction but permits relicensing or conveying under this |
|||
License, you may add to a covered work material governed by the terms |
|||
of that license document, provided that the further restriction does |
|||
not survive such relicensing or conveying. |
|||
|
|||
If you add terms to a covered work in accord with this section, you |
|||
must place, in the relevant source files, a statement of the |
|||
additional terms that apply to those files, or a notice indicating |
|||
where to find the applicable terms. |
|||
|
|||
Additional terms, permissive or non-permissive, may be stated in the |
|||
form of a separately written license, or stated as exceptions; |
|||
the above requirements apply either way. |
|||
|
|||
8. Termination. |
|||
|
|||
You may not propagate or modify a covered work except as expressly |
|||
provided under this License. Any attempt otherwise to propagate or |
|||
modify it is void, and will automatically terminate your rights under |
|||
this License (including any patent licenses granted under the third |
|||
paragraph of section 11). |
|||
|
|||
However, if you cease all violation of this License, then your |
|||
license from a particular copyright holder is reinstated (a) |
|||
provisionally, unless and until the copyright holder explicitly and |
|||
finally terminates your license, and (b) permanently, if the copyright |
|||
holder fails to notify you of the violation by some reasonable means |
|||
prior to 60 days after the cessation. |
|||
|
|||
Moreover, your license from a particular copyright holder is |
|||
reinstated permanently if the copyright holder notifies you of the |
|||
violation by some reasonable means, this is the first time you have |
|||
received notice of violation of this License (for any work) from that |
|||
copyright holder, and you cure the violation prior to 30 days after |
|||
your receipt of the notice. |
|||
|
|||
Termination of your rights under this section does not terminate the |
|||
licenses of parties who have received copies or rights from you under |
|||
this License. If your rights have been terminated and not permanently |
|||
reinstated, you do not qualify to receive new licenses for the same |
|||
material under section 10. |
|||
|
|||
9. Acceptance Not Required for Having Copies. |
|||
|
|||
You are not required to accept this License in order to receive or |
|||
run a copy of the Program. Ancillary propagation of a covered work |
|||
occurring solely as a consequence of using peer-to-peer transmission |
|||
to receive a copy likewise does not require acceptance. However, |
|||
nothing other than this License grants you permission to propagate or |
|||
modify any covered work. These actions infringe copyright if you do |
|||
not accept this License. Therefore, by modifying or propagating a |
|||
covered work, you indicate your acceptance of this License to do so. |
|||
|
|||
10. Automatic Licensing of Downstream Recipients. |
|||
|
|||
Each time you convey a covered work, the recipient automatically |
|||
receives a license from the original licensors, to run, modify and |
|||
propagate that work, subject to this License. You are not responsible |
|||
for enforcing compliance by third parties with this License. |
|||
|
|||
An "entity transaction" is a transaction transferring control of an |
|||
organization, or substantially all assets of one, or subdividing an |
|||
organization, or merging organizations. If propagation of a covered |
|||
work results from an entity transaction, each party to that |
|||
transaction who receives a copy of the work also receives whatever |
|||
licenses to the work the party's predecessor in interest had or could |
|||
give under the previous paragraph, plus a right to possession of the |
|||
Corresponding Source of the work from the predecessor in interest, if |
|||
the predecessor has it or can get it with reasonable efforts. |
|||
|
|||
You may not impose any further restrictions on the exercise of the |
|||
rights granted or affirmed under this License. For example, you may |
|||
not impose a license fee, royalty, or other charge for exercise of |
|||
rights granted under this License, and you may not initiate litigation |
|||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
|||
any patent claim is infringed by making, using, selling, offering for |
|||
sale, or importing the Program or any portion of it. |
|||
|
|||
11. Patents. |
|||
|
|||
A "contributor" is a copyright holder who authorizes use under this |
|||
License of the Program or a work on which the Program is based. The |
|||
work thus licensed is called the contributor's "contributor version". |
|||
|
|||
A contributor's "essential patent claims" are all patent claims |
|||
owned or controlled by the contributor, whether already acquired or |
|||
hereafter acquired, that would be infringed by some manner, permitted |
|||
by this License, of making, using, or selling its contributor version, |
|||
but do not include claims that would be infringed only as a |
|||
consequence of further modification of the contributor version. For |
|||
purposes of this definition, "control" includes the right to grant |
|||
patent sublicenses in a manner consistent with the requirements of |
|||
this License. |
|||
|
|||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
|||
patent license under the contributor's essential patent claims, to |
|||
make, use, sell, offer for sale, import and otherwise run, modify and |
|||
propagate the contents of its contributor version. |
|||
|
|||
In the following three paragraphs, a "patent license" is any express |
|||
agreement or commitment, however denominated, not to enforce a patent |
|||
(such as an express permission to practice a patent or covenant not to |
|||
sue for patent infringement). To "grant" such a patent license to a |
|||
party means to make such an agreement or commitment not to enforce a |
|||
patent against the party. |
|||
|
|||
If you convey a covered work, knowingly relying on a patent license, |
|||
and the Corresponding Source of the work is not available for anyone |
|||
to copy, free of charge and under the terms of this License, through a |
|||
publicly available network server or other readily accessible means, |
|||
then you must either (1) cause the Corresponding Source to be so |
|||
available, or (2) arrange to deprive yourself of the benefit of the |
|||
patent license for this particular work, or (3) arrange, in a manner |
|||
consistent with the requirements of this License, to extend the patent |
|||
license to downstream recipients. "Knowingly relying" means you have |
|||
actual knowledge that, but for the patent license, your conveying the |
|||
covered work in a country, or your recipient's use of the covered work |
|||
in a country, would infringe one or more identifiable patents in that |
|||
country that you have reason to believe are valid. |
|||
|
|||
If, pursuant to or in connection with a single transaction or |
|||
arrangement, you convey, or propagate by procuring conveyance of, a |
|||
covered work, and grant a patent license to some of the parties |
|||
receiving the covered work authorizing them to use, propagate, modify |
|||
or convey a specific copy of the covered work, then the patent license |
|||
you grant is automatically extended to all recipients of the covered |
|||
work and works based on it. |
|||
|
|||
A patent license is "discriminatory" if it does not include within |
|||
the scope of its coverage, prohibits the exercise of, or is |
|||
conditioned on the non-exercise of one or more of the rights that are |
|||
specifically granted under this License. You may not convey a covered |
|||
work if you are a party to an arrangement with a third party that is |
|||
in the business of distributing software, under which you make payment |
|||
to the third party based on the extent of your activity of conveying |
|||
the work, and under which the third party grants, to any of the |
|||
parties who would receive the covered work from you, a discriminatory |
|||
patent license (a) in connection with copies of the covered work |
|||
conveyed by you (or copies made from those copies), or (b) primarily |
|||
for and in connection with specific products or compilations that |
|||
contain the covered work, unless you entered into that arrangement, |
|||
or that patent license was granted, prior to 28 March 2007. |
|||
|
|||
Nothing in this License shall be construed as excluding or limiting |
|||
any implied license or other defenses to infringement that may |
|||
otherwise be available to you under applicable patent law. |
|||
|
|||
12. No Surrender of Others' Freedom. |
|||
|
|||
If conditions are imposed on you (whether by court order, agreement or |
|||
otherwise) that contradict the conditions of this License, they do not |
|||
excuse you from the conditions of this License. If you cannot convey a |
|||
covered work so as to satisfy simultaneously your obligations under this |
|||
License and any other pertinent obligations, then as a consequence you may |
|||
not convey it at all. For example, if you agree to terms that obligate you |
|||
to collect a royalty for further conveying from those to whom you convey |
|||
the Program, the only way you could satisfy both those terms and this |
|||
License would be to refrain entirely from conveying the Program. |
|||
|
|||
13. Remote Network Interaction; Use with the GNU General Public License. |
|||
|
|||
Notwithstanding any other provision of this License, if you modify the |
|||
Program, your modified version must prominently offer all users |
|||
interacting with it remotely through a computer network (if your version |
|||
supports such interaction) an opportunity to receive the Corresponding |
|||
Source of your version by providing access to the Corresponding Source |
|||
from a network server at no charge, through some standard or customary |
|||
means of facilitating copying of software. This Corresponding Source |
|||
shall include the Corresponding Source for any work covered by version 3 |
|||
of the GNU General Public License that is incorporated pursuant to the |
|||
following paragraph. |
|||
|
|||
Notwithstanding any other provision of this License, you have |
|||
permission to link or combine any covered work with a work licensed |
|||
under version 3 of the GNU General Public License into a single |
|||
combined work, and to convey the resulting work. The terms of this |
|||
License will continue to apply to the part which is the covered work, |
|||
but the work with which it is combined will remain governed by version |
|||
3 of the GNU General Public License. |
|||
|
|||
14. Revised Versions of this License. |
|||
|
|||
The Free Software Foundation may publish revised and/or new versions of |
|||
the GNU Affero General Public License from time to time. Such new versions |
|||
will be similar in spirit to the present version, but may differ in detail to |
|||
address new problems or concerns. |
|||
|
|||
Each version is given a distinguishing version number. If the |
|||
Program specifies that a certain numbered version of the GNU Affero General |
|||
Public License "or any later version" applies to it, you have the |
|||
option of following the terms and conditions either of that numbered |
|||
version or of any later version published by the Free Software |
|||
Foundation. If the Program does not specify a version number of the |
|||
GNU Affero General Public License, you may choose any version ever published |
|||
by the Free Software Foundation. |
|||
|
|||
If the Program specifies that a proxy can decide which future |
|||
versions of the GNU Affero General Public License can be used, that proxy's |
|||
public statement of acceptance of a version permanently authorizes you |
|||
to choose that version for the Program. |
|||
|
|||
Later license versions may give you additional or different |
|||
permissions. However, no additional obligations are imposed on any |
|||
author or copyright holder as a result of your choosing to follow a |
|||
later version. |
|||
|
|||
15. Disclaimer of Warranty. |
|||
|
|||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
|||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
|||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
|||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
|||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
|||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
|||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
|||
|
|||
16. Limitation of Liability. |
|||
|
|||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
|||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
|||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
|||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
|||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
|||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
|||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
|||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
|||
SUCH DAMAGES. |
|||
|
|||
17. Interpretation of Sections 15 and 16. |
|||
|
|||
If the disclaimer of warranty and limitation of liability provided |
|||
above cannot be given local legal effect according to their terms, |
|||
reviewing courts shall apply local law that most closely approximates |
|||
an absolute waiver of all civil liability in connection with the |
|||
Program, unless a warranty or assumption of liability accompanies a |
|||
copy of the Program in return for a fee. |
|||
|
|||
END OF TERMS AND CONDITIONS |
|||
|
|||
How to Apply These Terms to Your New Programs |
|||
|
|||
If you develop a new program, and you want it to be of the greatest |
|||
possible use to the public, the best way to achieve this is to make it |
|||
free software which everyone can redistribute and change under these terms. |
|||
|
|||
To do so, attach the following notices to the program. It is safest |
|||
to attach them to the start of each source file to most effectively |
|||
state the exclusion of warranty; and each file should have at least |
|||
the "copyright" line and a pointer to where the full notice is found. |
|||
|
|||
<one line to give the program's name and a brief idea of what it does.> |
|||
Copyright (C) <year> <name of author> |
|||
|
|||
This program is free software: you can redistribute it and/or modify |
|||
it under the terms of the GNU Affero General Public License as published |
|||
by the Free Software Foundation, either version 3 of the License, or |
|||
(at your option) any later version. |
|||
|
|||
This program is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
GNU Affero General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Affero General Public License |
|||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
|||
|
|||
Also add information on how to contact you by electronic and paper mail. |
|||
|
|||
If your software can interact with users remotely through a computer |
|||
network, you should also make sure that it provides a way for users to |
|||
get its source. For example, if your program is a web application, its |
|||
interface could display a "Source" link that leads users to an archive |
|||
of the code. There are many ways you could offer source, and different |
|||
solutions will be better for different programs; see section 13 for the |
|||
specific requirements. |
|||
|
|||
You should also get your employer (if you work as a programmer) or school, |
|||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
|||
For more information on this, and how to apply and follow the GNU AGPL, see |
|||
<https://www.gnu.org/licenses/>. |
|||
@ -0,0 +1,22 @@ |
|||
[](https://github.com/Tecnativa/doodba) |
|||
[](https://github.com/Tecnativa/doodba-copier-template/tree/v2.4.2) |
|||
[](https://github.com/odoo/odoo/tree/14.0) |
|||
[](LICENSE) |
|||
[](https://pre-commit.com/) |
|||
|
|||
# myproject-odoo - a Doodba deployment |
|||
|
|||
This project is a Doodba scaffolding. Check upstream docs on the matter: |
|||
|
|||
- [General Doodba docs](https://github.com/Tecnativa/doodba). |
|||
- [Doodba copier template docs](https://github.com/Tecnativa/doodba-copier-template) |
|||
- [Doodba QA docs](https://github.com/Tecnativa/doodba-qa) |
|||
|
|||
# Credits |
|||
|
|||
This project is maintained by: |
|||
|
|||
[](https://www.tecnativa.com/r/bb4) |
|||
|
|||
Also, special thanks to |
|||
[our dear community contributors](https://github.com/Tecnativa/doodba-copier-template/graphs/contributors). |
|||
@ -0,0 +1,33 @@ |
|||
version: "2.4" |
|||
|
|||
services: |
|||
odoo: |
|||
build: |
|||
context: ./odoo |
|||
args: |
|||
ODOO_VERSION: "14.0" |
|||
UID: "${UID:-1000}" |
|||
GID: "${GID:-1000}" |
|||
environment: |
|||
EMAIL_FROM: "" |
|||
PGDATABASE: &dbname prod |
|||
PGUSER: &dbuser "odoo" |
|||
DB_FILTER: ".*" |
|||
PROXY_MODE: "false" |
|||
tty: true |
|||
volumes: |
|||
- filestore:/var/lib/odoo:z |
|||
|
|||
db: |
|||
image: ghcr.io/tecnativa/postgres-autoconf:10-alpine |
|||
shm_size: 512mb |
|||
environment: |
|||
POSTGRES_DB: *dbname |
|||
POSTGRES_USER: *dbuser |
|||
CONF_EXTRA: | |
|||
work_mem = 512MB |
|||
volumes: |
|||
- db:/var/lib/postgresql/data:z |
|||
|
|||
smtpfake: |
|||
image: mailhog/mailhog |
|||
@ -0,0 +1,162 @@ |
|||
version: "2.4" |
|||
|
|||
services: |
|||
odoo_proxy: |
|||
image: tecnativa/whitelist |
|||
depends_on: |
|||
- odoo |
|||
networks: &public |
|||
default: |
|||
public: |
|||
ports: |
|||
- "127.0.0.1:14899:6899" |
|||
- "127.0.0.1:14069:8069" |
|||
environment: |
|||
PORT: "6899 8069" |
|||
TARGET: odoo |
|||
|
|||
odoo: |
|||
extends: |
|||
file: common.yaml |
|||
service: odoo |
|||
build: |
|||
args: |
|||
# To aggregate in development, use `setup-devel.yaml` |
|||
AGGREGATE: "false" |
|||
# Export these variables to own files created by odoo in your filesystem |
|||
UID: "${UID:-1000}" |
|||
GID: "${GID:-1000}" |
|||
# No need for this in development |
|||
PIP_INSTALL_ODOO: "false" |
|||
CLEAN: "false" |
|||
COMPILE: "false" |
|||
environment: |
|||
DOODBA_ENVIRONMENT: "${DOODBA_ENVIRONMENT-devel}" |
|||
LIST_DB: "true" |
|||
DEBUGPY_ENABLE: "${DOODBA_DEBUGPY_ENABLE:-0}" |
|||
PGDATABASE: &dbname devel |
|||
PYTHONDONTWRITEBYTECODE: 1 |
|||
PYTHONOPTIMIZE: "" |
|||
PYTHONPATH: /opt/odoo/custom/src/odoo |
|||
SMTP_PORT: "1025" |
|||
WDB_WEB_PORT: "14984" |
|||
# To avoid installing demo data export DOODBA_WITHOUT_DEMO=all |
|||
WITHOUT_DEMO: "${DOODBA_WITHOUT_DEMO-false}" |
|||
volumes: |
|||
- ./odoo/custom:/opt/odoo/custom:ro,z |
|||
- ./odoo/auto:/opt/odoo/auto:rw,z |
|||
depends_on: |
|||
- cdnjs_cloudflare_proxy |
|||
- db |
|||
- fonts_googleapis_proxy |
|||
- fonts_gstatic_proxy |
|||
- google_proxy |
|||
- gravatar_proxy |
|||
- smtp |
|||
- wdb |
|||
command: |
|||
- odoo |
|||
- --limit-memory-soft=0 |
|||
- --limit-time-real-cron=9999999 |
|||
- --limit-time-real=9999999 |
|||
- --workers=0 |
|||
- --dev=reload,qweb,werkzeug,xml |
|||
|
|||
db: |
|||
extends: |
|||
file: common.yaml |
|||
service: db |
|||
environment: |
|||
POSTGRES_DB: *dbname |
|||
POSTGRES_PASSWORD: odoopassword |
|||
|
|||
pgweb: |
|||
image: sosedoff/pgweb |
|||
networks: *public |
|||
ports: |
|||
- "127.0.0.1:14081:8081" |
|||
environment: |
|||
DATABASE_URL: postgres://odoo:odoopassword@db:5432/devel?sslmode=disable |
|||
depends_on: |
|||
- db |
|||
|
|||
smtp: |
|||
extends: |
|||
file: common.yaml |
|||
service: smtpfake |
|||
networks: *public |
|||
ports: |
|||
- "127.0.0.1:14025:8025" |
|||
|
|||
wdb: |
|||
image: kozea/wdb |
|||
networks: *public |
|||
ports: |
|||
- "127.0.0.1:14984:1984" |
|||
# HACK https://github.com/Kozea/wdb/issues/136 |
|||
init: true |
|||
|
|||
# Whitelist outgoing traffic for tests, reports, etc. |
|||
cdnjs_cloudflare_proxy: |
|||
image: tecnativa/whitelist |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- cdnjs.cloudflare.com |
|||
public: |
|||
environment: |
|||
TARGET: cdnjs.cloudflare.com |
|||
PRE_RESOLVE: 1 |
|||
|
|||
fonts_googleapis_proxy: |
|||
image: tecnativa/whitelist |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- fonts.googleapis.com |
|||
public: |
|||
environment: |
|||
TARGET: fonts.googleapis.com |
|||
PRE_RESOLVE: 1 |
|||
|
|||
fonts_gstatic_proxy: |
|||
image: tecnativa/whitelist |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- fonts.gstatic.com |
|||
public: |
|||
environment: |
|||
TARGET: fonts.gstatic.com |
|||
PRE_RESOLVE: 1 |
|||
|
|||
google_proxy: |
|||
image: tecnativa/whitelist |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- www.google.com |
|||
public: |
|||
environment: |
|||
TARGET: www.google.com |
|||
PRE_RESOLVE: 1 |
|||
|
|||
gravatar_proxy: |
|||
image: tecnativa/whitelist |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- www.gravatar.com |
|||
public: |
|||
environment: |
|||
TARGET: www.gravatar.com |
|||
PRE_RESOLVE: 1 |
|||
|
|||
networks: |
|||
default: |
|||
internal: true |
|||
public: |
|||
|
|||
volumes: |
|||
filestore: |
|||
db: |
|||
@ -0,0 +1,4 @@ |
|||
# Ignore all src directories except private and files with a dot |
|||
custom/src/* |
|||
!custom/src/private |
|||
!custom/src/*.* |
|||
@ -0,0 +1,2 @@ |
|||
ARG ODOO_VERSION |
|||
FROM tecnativa/doodba:${ODOO_VERSION}-onbuild |
|||
@ -0,0 +1,3 @@ |
|||
git+https://github.com/OCA/openupgradelib.git@master |
|||
unicodecsv |
|||
unidecode |
|||
@ -0,0 +1,20 @@ |
|||
# Configuration for known file extensions |
|||
[*.{css,js,json,less,md,py,rst,sass,scss,xml,yaml,yml}] |
|||
charset = utf-8 |
|||
end_of_line = lf |
|||
indent_size = 4 |
|||
indent_style = space |
|||
insert_final_newline = true |
|||
trim_trailing_whitespace = true |
|||
|
|||
[*.{json,yml,yaml,rst,md}] |
|||
indent_size = 2 |
|||
|
|||
# Do not configure editor for libs and autogenerated content |
|||
[{*/static/{lib,src/lib}/**,*/static/description/index.html,*/readme/../README.rst}] |
|||
charset = unset |
|||
end_of_line = unset |
|||
indent_size = unset |
|||
indent_style = unset |
|||
insert_final_newline = false |
|||
trim_trailing_whitespace = false |
|||
@ -0,0 +1,16 @@ |
|||
# See https://github.com/Tecnativa/doodba#optodoocustomsrcreposyaml |
|||
./odoo: |
|||
defaults: |
|||
# Shallow repositories ($DEPTH_DEFAULT=1) are faster & thinner |
|||
# You may need a bigger depth when merging PRs (use $DEPTH_MERGE |
|||
# for a sane value of 100 commits) |
|||
depth: $DEPTH_DEFAULT |
|||
remotes: |
|||
ocb: https://github.com/OCA/OCB.git |
|||
odoo: https://github.com/odoo/odoo.git |
|||
openupgrade: https://github.com/OCA/OpenUpgrade.git |
|||
target: ocb $ODOO_VERSION |
|||
merges: |
|||
- ocb $ODOO_VERSION |
|||
# Example of a merge of the PR with the number <PR> |
|||
# - oca refs/pull/<PR>/head |
|||
@ -0,0 +1 @@ |
|||
# See syntax in https://www.ssh.com/ssh/config/ and `man ssh_config` |
|||
@ -0,0 +1,14 @@ |
|||
# Use `ssh-keyscan` to fill this file and ensure remote git hosts ssh keys |
|||
|
|||
# bitbucket.org:22 SSH-2.0-conker_1.0.298-8c5a6f7 app-126 |
|||
bitbucket.org ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAubiN81eDcafrgMeLzaFPsw2kNvEcqTKl/VqLat/MaB33pZy0y3rJZtnqwR2qOOvbwKZYKiEO1O6VqNEBxKvJJelCq0dTXWT5pbO2gDXC6h6QDXCaHo6pOHGPUy+YBaGQRGuSusMEASYiWunYN0vCAI8QaXnWMXNMdFP3jHAJH0eDsoiGnLPBlBp4TNm6rYI74nMzgz3B9IikW4WVK+dc8KZJZWYjAuORU3jc1c/NPskD2ASinf8v3xnfXeukU0sJ5N6m5E8VLjObPEO+mN2t/FZTMZLiFqPWc/ALSqnMnnhwrNi2rbfg/rd/IpL8Le3pSBne8+seeFVBoGqzHM9yXw== |
|||
|
|||
# github.com:22 SSH-2.0-libssh-0.7.0 |
|||
github.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ== |
|||
|
|||
# gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2 |
|||
gitlab.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onrSzH9bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9 |
|||
# gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2 |
|||
gitlab.com ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBFSMqzJeV9rUzU4kWitGjeR4PWSa29SPqJ1fVkhtj3Hw9xjLVXVYrU9QlYWrOLXBpQ6KWjbjTDTdDkoohFzgbEY= |
|||
# gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2 |
|||
gitlab.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAfuCHKVTjquxvt6CM6tdG4SLp1Btn/nOeHHE5UOzRdf |
|||
@ -0,0 +1,37 @@ |
|||
version: "2.4" |
|||
|
|||
services: |
|||
odoo: |
|||
extends: |
|||
file: common.yaml |
|||
service: odoo |
|||
restart: unless-stopped |
|||
env_file: |
|||
- .docker/odoo.env |
|||
- .docker/db-access.env |
|||
environment: |
|||
DOODBA_ENVIRONMENT: "${DOODBA_ENVIRONMENT-prod}" |
|||
INITIAL_LANG: "fr_FR" |
|||
depends_on: |
|||
- db |
|||
networks: |
|||
default: |
|||
labels: |
|||
doodba.domain.main: "" |
|||
|
|||
db: |
|||
extends: |
|||
file: common.yaml |
|||
service: db |
|||
env_file: |
|||
- .docker/db-creation.env |
|||
restart: unless-stopped |
|||
|
|||
networks: |
|||
default: |
|||
driver_opts: |
|||
encrypted: 1 |
|||
|
|||
volumes: |
|||
filestore: |
|||
db: |
|||
@ -0,0 +1,40 @@ |
|||
# Use this environment to download all repositories from `repos.yaml` file: |
|||
# |
|||
# export UID="$(id -u $USER)" GID="$(id -g $USER)" UMASK="$(umask)" |
|||
# docker-compose -f setup-devel.yaml run --rm odoo |
|||
# |
|||
# You can clean your git project before if you want to have all really clean: |
|||
# |
|||
# git clean -ffd |
|||
|
|||
version: "2.4" |
|||
|
|||
services: |
|||
odoo: |
|||
build: |
|||
context: ./odoo |
|||
args: |
|||
AGGREGATE: "false" |
|||
DEPTH_DEFAULT: 100 |
|||
ODOO_VERSION: "14.0" |
|||
PYTHONOPTIMIZE: "" |
|||
PIP_INSTALL_ODOO: "false" |
|||
CLEAN: "false" |
|||
COMPILE: "false" |
|||
UID: "${UID:-1000}" |
|||
GID: "${GID:-1000}" |
|||
networks: |
|||
- public |
|||
volumes: |
|||
- ./odoo/custom/src:/opt/odoo/custom/src:rw,z |
|||
environment: |
|||
DEPTH_DEFAULT: 100 |
|||
# XXX Export these variables before running setup to own the files |
|||
UID: "${UID:-1000}" |
|||
GID: "${GID:-1000}" |
|||
UMASK: "$UMASK" |
|||
user: root |
|||
entrypoint: autoaggregate |
|||
|
|||
networks: |
|||
public: |
|||
@ -0,0 +1,354 @@ |
|||
"""Doodba child project tasks. |
|||
|
|||
This file is to be executed with https://www.pyinvoke.org/ in Python 3.6+. |
|||
|
|||
Contains common helpers to develop using this child project. |
|||
""" |
|||
import json |
|||
import os |
|||
from itertools import chain |
|||
from pathlib import Path |
|||
from shutil import which |
|||
|
|||
from invoke import task |
|||
|
|||
ODOO_VERSION = 14.0 |
|||
PROJECT_ROOT = Path(__file__).parent.absolute() |
|||
SRC_PATH = PROJECT_ROOT / "odoo" / "custom" / "src" |
|||
UID_ENV = {"GID": str(os.getgid()), "UID": str(os.getuid()), "UMASK": "27"} |
|||
|
|||
|
|||
@task |
|||
def write_code_workspace_file(c, cw_path=None): |
|||
"""Generate code-workspace file definition. |
|||
|
|||
Some other tasks will call this one when needed, and since you cannot specify |
|||
the file name there, if you want a specific one, you should call this task |
|||
before. |
|||
|
|||
Most times you just can forget about this task and let it be run automatically |
|||
whenever needed. |
|||
|
|||
If you don't define a workspace name, this task will reuse the 1st |
|||
`doodba.*.code-workspace` file found inside the current directory. |
|||
If none is found, it will default to `doodba.$(basename $PWD).code-workspace`. |
|||
|
|||
If you define it manually, remember to use the same prefix and suffix if you |
|||
want it git-ignored by default. |
|||
Example: `--cw-path doodba.my-custom-name.code-workspace` |
|||
""" |
|||
root_name = f"doodba.{PROJECT_ROOT.name}" |
|||
root_var = "${workspaceRoot:%s}" % root_name |
|||
if not cw_path: |
|||
try: |
|||
cw_path = next(PROJECT_ROOT.glob("doodba.*.code-workspace")) |
|||
except StopIteration: |
|||
cw_path = f"{root_name}.code-workspace" |
|||
if not Path(cw_path).is_absolute(): |
|||
cw_path = PROJECT_ROOT / cw_path |
|||
cw_config = {} |
|||
try: |
|||
with open(cw_path) as cw_fd: |
|||
cw_config = json.load(cw_fd) |
|||
except (FileNotFoundError, json.decoder.JSONDecodeError): |
|||
pass # Nevermind, we start with a new config |
|||
# Launch configurations |
|||
debugpy_configuration = { |
|||
"name": "Attach Python debugger to running container", |
|||
"type": "python", |
|||
"request": "attach", |
|||
"pathMappings": [{"localRoot": f"{root_var}/odoo", "remoteRoot": "/opt/odoo"}], |
|||
"port": int(ODOO_VERSION) * 1000 + 899, |
|||
"host": "localhost", |
|||
} |
|||
firefox_configuration = { |
|||
"type": "firefox", |
|||
"request": "launch", |
|||
"reAttach": True, |
|||
"name": "Connect to firefox debugger", |
|||
"url": f"http://localhost:{ODOO_VERSION:.0f}069/?debug=assets", |
|||
"reloadOnChange": { |
|||
"watch": f"{root_var}/odoo/custom/src/**/*.{'{js,css,scss,less}'}" |
|||
}, |
|||
"skipFiles": ["**/lib/**"], |
|||
"pathMappings": [], |
|||
} |
|||
chrome_executable = which("chrome") or which("chromium") |
|||
chrome_configuration = { |
|||
"type": "chrome", |
|||
"request": "launch", |
|||
"name": "Connect to chrome debugger", |
|||
"url": f"http://localhost:{ODOO_VERSION:.0f}069/?debug=assets", |
|||
"skipFiles": ["**/lib/**"], |
|||
"trace": True, |
|||
"pathMapping": {}, |
|||
} |
|||
if chrome_executable: |
|||
chrome_configuration["runtimeExecutable"] = chrome_executable |
|||
cw_config["launch"] = { |
|||
"compounds": [ |
|||
{ |
|||
"name": "Start Odoo and debug Python", |
|||
"configurations": ["Attach Python debugger to running container"], |
|||
"preLaunchTask": "Start Odoo in debug mode", |
|||
}, |
|||
{ |
|||
"name": "Start Odoo and debug JS in Firefox", |
|||
"configurations": ["Connect to firefox debugger"], |
|||
"preLaunchTask": "Start Odoo", |
|||
}, |
|||
{ |
|||
"name": "Start Odoo and debug JS in Chrome", |
|||
"configurations": ["Connect to chrome debugger"], |
|||
"preLaunchTask": "Start Odoo", |
|||
}, |
|||
{ |
|||
"name": "Start Odoo and debug Python + JS in Firefox", |
|||
"configurations": [ |
|||
"Attach Python debugger to running container", |
|||
"Connect to firefox debugger", |
|||
], |
|||
"preLaunchTask": "Start Odoo in debug mode", |
|||
}, |
|||
{ |
|||
"name": "Start Odoo and debug Python + JS in Chrome", |
|||
"configurations": [ |
|||
"Attach Python debugger to running container", |
|||
"Connect to chrome debugger", |
|||
], |
|||
"preLaunchTask": "Start Odoo in debug mode", |
|||
}, |
|||
], |
|||
"configurations": [ |
|||
debugpy_configuration, |
|||
firefox_configuration, |
|||
chrome_configuration, |
|||
], |
|||
} |
|||
# Configure folders |
|||
cw_config["folders"] = [] |
|||
for subrepo in SRC_PATH.glob("*"): |
|||
if not subrepo.is_dir(): |
|||
continue |
|||
if (subrepo / ".git").exists() and subrepo.name != "odoo": |
|||
cw_config["folders"].append( |
|||
{"path": str(subrepo.relative_to(PROJECT_ROOT))} |
|||
) |
|||
debugpy_configuration["pathMappings"].append( |
|||
{ |
|||
"localRoot": "${workspaceRoot:%s}" % subrepo.name, |
|||
"remoteRoot": f"/opt/odoo/custom/src/{subrepo.name}", |
|||
} |
|||
) |
|||
for addon in chain(subrepo.glob("*"), subrepo.glob("addons/*")): |
|||
if (addon / "__manifest__.py").is_file() or ( |
|||
addon / "__openerp__.py" |
|||
).is_file(): |
|||
url = f"http://localhost:{ODOO_VERSION:.0f}069/{addon.name}/static/" |
|||
path = "${{workspaceRoot:{}}}/{}/static/".format( |
|||
subrepo.name, |
|||
addon.relative_to(subrepo), |
|||
) |
|||
firefox_configuration["pathMappings"].append({"url": url, "path": path}) |
|||
chrome_configuration["pathMapping"][url] = path |
|||
cw_config["tasks"] = { |
|||
"version": "2.0.0", |
|||
"tasks": [ |
|||
{ |
|||
"label": "Start Odoo", |
|||
"type": "process", |
|||
"command": "invoke", |
|||
"args": ["start", "--detach"], |
|||
"presentation": { |
|||
"echo": True, |
|||
"reveal": "silent", |
|||
"focus": False, |
|||
"panel": "shared", |
|||
"showReuseMessage": True, |
|||
"clear": False, |
|||
}, |
|||
"problemMatcher": [], |
|||
}, |
|||
{ |
|||
"label": "Start Odoo in debug mode", |
|||
"type": "process", |
|||
"command": "invoke", |
|||
"args": ["start", "--detach", "--debugpy"], |
|||
"presentation": { |
|||
"echo": True, |
|||
"reveal": "silent", |
|||
"focus": False, |
|||
"panel": "shared", |
|||
"showReuseMessage": True, |
|||
"clear": False, |
|||
}, |
|||
"problemMatcher": [], |
|||
}, |
|||
{ |
|||
"label": "Stop Odoo", |
|||
"type": "process", |
|||
"command": "invoke", |
|||
"args": ["stop"], |
|||
"presentation": { |
|||
"echo": True, |
|||
"reveal": "silent", |
|||
"focus": False, |
|||
"panel": "shared", |
|||
"showReuseMessage": True, |
|||
"clear": False, |
|||
}, |
|||
"problemMatcher": [], |
|||
}, |
|||
], |
|||
} |
|||
# Sort project folders |
|||
cw_config["folders"].sort(key=lambda x: x["path"]) |
|||
# Put Odoo folder just before private and top folder |
|||
odoo = SRC_PATH / "odoo" |
|||
if odoo.is_dir(): |
|||
cw_config["folders"].append({"path": str(odoo.relative_to(PROJECT_ROOT))}) |
|||
# HACK https://github.com/microsoft/vscode/issues/95963 put private second to last |
|||
private = SRC_PATH / "private" |
|||
if private.is_dir(): |
|||
cw_config["folders"].append({"path": str(private.relative_to(PROJECT_ROOT))}) |
|||
# HACK https://github.com/microsoft/vscode/issues/37947 put top folder last |
|||
cw_config["folders"].append({"path": ".", "name": root_name}) |
|||
with open(cw_path, "w") as cw_fd: |
|||
json.dump(cw_config, cw_fd, indent=2) |
|||
cw_fd.write("\n") |
|||
|
|||
|
|||
@task |
|||
def develop(c): |
|||
"""Set up a basic development environment.""" |
|||
# Prepare environment |
|||
Path(PROJECT_ROOT, "odoo", "auto", "addons").mkdir(parents=True, exist_ok=True) |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run("git init") |
|||
c.run("ln -sf devel.yaml docker-compose.yml") |
|||
write_code_workspace_file(c) |
|||
c.run("pre-commit install") |
|||
|
|||
|
|||
@task(develop) |
|||
def git_aggregate(c): |
|||
"""Download odoo & addons git code. |
|||
|
|||
Executes git-aggregator from within the doodba container. |
|||
""" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run( |
|||
"docker-compose --file setup-devel.yaml run --rm odoo", |
|||
env=UID_ENV, |
|||
) |
|||
write_code_workspace_file(c) |
|||
for git_folder in SRC_PATH.glob("*/.git/.."): |
|||
action = ( |
|||
"install" |
|||
if (git_folder / ".pre-commit-config.yaml").is_file() |
|||
else "uninstall" |
|||
) |
|||
with c.cd(str(git_folder)): |
|||
c.run(f"pre-commit {action}") |
|||
|
|||
|
|||
@task(develop) |
|||
def img_build(c, pull=True): |
|||
"""Build docker images.""" |
|||
cmd = "docker-compose build" |
|||
if pull: |
|||
cmd += " --pull" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd, env=UID_ENV) |
|||
|
|||
|
|||
@task(develop) |
|||
def img_pull(c): |
|||
"""Pull docker images.""" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run("docker-compose pull") |
|||
|
|||
|
|||
@task(develop) |
|||
def lint(c, verbose=False): |
|||
"""Lint & format source code.""" |
|||
cmd = "pre-commit run --show-diff-on-failure --all-files --color=always" |
|||
if verbose: |
|||
cmd += " --verbose" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd) |
|||
|
|||
|
|||
@task(develop) |
|||
def start(c, detach=True, debugpy=False): |
|||
"""Start environment.""" |
|||
cmd = "docker-compose up" |
|||
if detach: |
|||
cmd += " --detach" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd, env=dict(UID_ENV, DOODBA_DEBUGPY_ENABLE=str(int(debugpy)))) |
|||
|
|||
|
|||
@task( |
|||
develop, |
|||
help={"purge": "Remove all related containers, networks images and volumes"}, |
|||
) |
|||
def stop(c, purge=False): |
|||
"""Stop and (optionally) purge environment.""" |
|||
cmd = "docker-compose" |
|||
if purge: |
|||
cmd += " down --remove-orphans --rmi local --volumes" |
|||
else: |
|||
cmd += " stop" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd) |
|||
|
|||
|
|||
@task( |
|||
develop, |
|||
help={ |
|||
"dbname": "The DB that will be DESTROYED and recreated. Default: 'devel'.", |
|||
"modules": "Comma-separated list of modules to install. Default: 'base'.", |
|||
}, |
|||
) |
|||
def resetdb(c, modules="base", dbname="devel"): |
|||
"""Reset the specified database with the specified modules. |
|||
|
|||
Uses click-odoo-initdb behind the scenes, which has a caching system that |
|||
makes DB resets quicker. See its docs for more info. |
|||
""" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run("docker-compose stop odoo", pty=True) |
|||
_run = "docker-compose run --rm -l traefik.enable=false odoo" |
|||
c.run( |
|||
f"{_run} click-odoo-dropdb {dbname}", |
|||
env=UID_ENV, |
|||
warn=True, |
|||
pty=True, |
|||
) |
|||
c.run( |
|||
f"{_run} click-odoo-initdb -n {dbname} -m {modules}", |
|||
env=UID_ENV, |
|||
pty=True, |
|||
) |
|||
|
|||
|
|||
@task(develop) |
|||
def restart(c, quick=True): |
|||
"""Restart odoo container(s).""" |
|||
cmd = "docker-compose restart" |
|||
if quick: |
|||
cmd = f"{cmd} -t0" |
|||
cmd = f"{cmd} odoo odoo_proxy" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd, env=UID_ENV) |
|||
|
|||
|
|||
@task(develop) |
|||
def logs(c, tail=10): |
|||
"""Obtain last logs of current environment.""" |
|||
cmd = "docker-compose logs -f" |
|||
if tail: |
|||
cmd += f" --tail {tail}" |
|||
with c.cd(str(PROJECT_ROOT)): |
|||
c.run(cmd) |
|||
@ -0,0 +1,68 @@ |
|||
version: "2.4" |
|||
|
|||
services: |
|||
odoo: |
|||
extends: |
|||
file: common.yaml |
|||
service: odoo |
|||
env_file: |
|||
- .docker/odoo.env |
|||
- .docker/db-access.env |
|||
environment: |
|||
DOODBA_ENVIRONMENT: "${DOODBA_ENVIRONMENT-test}" |
|||
# To install demo data export DOODBA_WITHOUT_DEMO=false |
|||
WITHOUT_DEMO: "${DOODBA_WITHOUT_DEMO-all}" |
|||
SMTP_PORT: "1025" |
|||
SMTP_SERVER: smtplocal |
|||
restart: unless-stopped |
|||
depends_on: |
|||
- db |
|||
- smtp |
|||
networks: |
|||
default: |
|||
globalwhitelist_shared: |
|||
labels: |
|||
doodba.domain.main: "" |
|||
command: |
|||
- odoo |
|||
- --workers=2 |
|||
- --max-cron-threads=1 |
|||
|
|||
db: |
|||
extends: |
|||
file: common.yaml |
|||
service: db |
|||
env_file: |
|||
- .docker/db-creation.env |
|||
restart: unless-stopped |
|||
|
|||
smtp: |
|||
extends: |
|||
file: common.yaml |
|||
service: smtpfake |
|||
restart: unless-stopped |
|||
networks: |
|||
default: |
|||
aliases: |
|||
- smtplocal |
|||
labels: |
|||
doodba.domain.main: "" |
|||
volumes: |
|||
- "smtpconf:/etc/mailhog:ro,z" |
|||
entrypoint: [sh, -c] |
|||
command: |
|||
- test -r /etc/mailhog/auth && export MH_AUTH_FILE=/etc/mailhog/auth; exec MailHog |
|||
|
|||
networks: |
|||
default: |
|||
internal: true |
|||
driver_opts: |
|||
encrypted: 1 |
|||
|
|||
globalwhitelist_shared: |
|||
external: true |
|||
|
|||
volumes: |
|||
filestore: |
|||
db: |
|||
smtpconf: |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue