changeset 82d9d0a3072c in
modules/sale_product_recommendation_association_rule:default
details:
https://hg.tryton.org/modules/sale_product_recommendation_association_rule?cmd=changeset&node=82d9d0a3072c
description:
Add product recommendation modules
issue11528
review417301003
diffstat:
.drone.yml | 78 +
.flake8 | 2 +
.isort.cfg | 3 +
COPYRIGHT | 15 +
LICENSE | 674
++++++++++
MANIFEST.in | 5 +
README.rst | 1 +
__init__.py | 23 +
doc/conf.py | 61 +
doc/design.rst | 34 +
doc/index.rst | 14 +
doc/usage.rst | 17 +
ir.py | 15 +
sale.py | 283 ++++
sale.xml | 59 +
setup.py | 165 ++
tests/__init__.py | 2 +
tests/scenario_sale_product_recommendation_association_rule.rst | 161 ++
tests/test_module.py | 12 +
tests/test_scenario.py | 8 +
tox.ini | 17 +
tryton.cfg | 11 +
view/configuration_form.xml | 18 +
view/product_association_rule_form.xml | 21 +
view/product_association_rule_list.xml | 11 +
25 files changed, 1710 insertions(+), 0 deletions(-)
diffs (1811 lines):
diff -r 000000000000 -r 82d9d0a3072c .drone.yml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.drone.yml Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,78 @@
+clone:
+ hg:
+ image: plugins/hg
+ environment:
+ - HG_SHARE_POOL=/root/.cache/hg
+ volumes:
+ - cache:/root/.cache
+
+pipeline:
+ tox:
+ image: ${IMAGE}
+ environment:
+ - CFLAGS=-O0
+ - DB_CACHE=/cache
+ - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE CI_BUILD_NUMBER
CI_JOB_NUMBER CI_JOB_ID
+ - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/
+ commands:
+ - echo "[extensions]" >> /root/.hgrc
+ - echo "hgext.share =" >> /root/.hgrc
+ - echo "[share]" >> /root/.hgrc
+ - echo "pool = /root/.cache/hg" >> /root/.hgrc
+ - pip install tox
+ - tox -e "${TOXENV}-${DATABASE}"
+ volumes:
+ - cache:/root/.cache
+ check_dist:
+ image: ${IMAGE}
+ commands:
+ - pip install twine
+ - python setup.py sdist
+ - twine check dist/*
+ volumes:
+ - cache:/root/.cache
+ check_doc:
+ image: ${IMAGE}
+ commands:
+ - pip install sphinx
+ - python -m sphinx -T -E -W -n -b html doc _build/html
+ - python -m sphinx -T -E -W -n -b linkcheck doc _build
+ volumes:
+ - cache:/root/.cache
+
+services:
+ postgresql:
+ image: postgres
+ environment:
+ - POSTGRES_HOST_AUTH_METHOD=trust
+ command: "-c fsync=off -c synchronous_commit=off -c
full_page_writes=off"
+ when:
+ matrix:
+ DATABASE: postgresql
+
+matrix:
+ include:
+ - IMAGE: python:3.7
+ TOXENV: py37
+ DATABASE: sqlite
+ - IMAGE: python:3.7
+ TOXENV: py37
+ DATABASE: postgresql
+ - IMAGE: python:3.8
+ TOXENV: py38
+ DATABASE: sqlite
+ - IMAGE: python:3.8
+ TOXENV: py38
+ DATABASE: postgresql
+ - IMAGE: python:3.9
+ TOXENV: py39
+ DATABASE: sqlite
+ - IMAGE: python:3.9
+ TOXENV: py39
+ DATABASE: postgresql
+ - IMAGE: python:3.10
+ TOXENV: py310
+ DATABASE: sqlite
+ - IMAGE: python:3.10
+ TOXENV: py310
+ DATABASE: postgresql
diff -r 000000000000 -r 82d9d0a3072c .flake8
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.flake8 Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,2 @@
+[flake8]
+ignore=E123,E124,E126,E128,E741,W503
diff -r 000000000000 -r 82d9d0a3072c .isort.cfg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.isort.cfg Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,3 @@
+[settings]
+multi_line_output=4
+known_first_party=trytond
diff -r 000000000000 -r 82d9d0a3072c COPYRIGHT
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/COPYRIGHT Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,15 @@
+Copyright (C) 2022 B2CK
+Copyright (C) 2022 Cédric Krier
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
diff -r 000000000000 -r 82d9d0a3072c LICENSE
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is 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. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ 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.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ 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 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. Use with the GNU Affero General Public License.
+
+ 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 Affero 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 special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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 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 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 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 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ 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 GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff -r 000000000000 -r 82d9d0a3072c MANIFEST.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/MANIFEST.in Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,5 @@
+include CHANGELOG
+include COPYRIGHT
+include LICENSE
+include README.rst
+graft doc
diff -r 000000000000 -r 82d9d0a3072c README.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,1 @@
+doc/index.rst
\ No newline at end of file
diff -r 000000000000 -r 82d9d0a3072c __init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/__init__.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,23 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import Pool
+
+from . import ir, sale
+
+__all__ = ['register']
+
+
+def register():
+ Pool.register(
+ ir.Cron,
+ sale.Configuration,
+ sale.Sale,
+ sale.ProductAssociationRule,
+ sale.ProductAssociationRuleAntecedent,
+ sale.ProductAssociationRuleConsequent,
+ module='sale_product_recommendation_association_rule', type_='model')
+ Pool.register(
+ sale.ProductAssociationRulePOS,
+ module='sale_product_recommendation_association_rule', type_='model',
+ depends=['sale_point'])
diff -r 000000000000 -r 82d9d0a3072c doc/conf.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/conf.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,61 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/'
+trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/'
+
+
+def get_info():
+ import configparser
+ import os
+ import subprocess
+ import sys
+
+ module_dir = os.path.dirname(os.path.dirname(__file__))
+
+ config = configparser.ConfigParser()
+ config.read_file(open(os.path.join(module_dir, 'tryton.cfg')))
+ info = dict(config.items('tryton'))
+
+ result = subprocess.run(
+ [sys.executable, 'setup.py', '--name'],
+ stdout=subprocess.PIPE, check=True, cwd=module_dir)
+ info['name'] = result.stdout.decode('utf-8').strip()
+
+ result = subprocess.run(
+ [sys.executable, 'setup.py', '--version'],
+ stdout=subprocess.PIPE, check=True, cwd=module_dir)
+ version = result.stdout.decode('utf-8').strip()
+ if 'dev' in version:
+ info['series'] = 'latest'
+ else:
+ info['series'] = '.'.join(version.split('.', 2)[:2])
+
+ for key in {'depends', 'extras_depend'}:
+ info[key] = info.get(key, '').strip().splitlines()
+ info['modules'] = set(info['depends'] + info['extras_depend'])
+ info['modules'] -= {'ir', 'res'}
+
+ return info
+
+
+info = get_info()
+
+master_doc = 'index'
+project = info['name']
+release = version = info['series']
+default_role = 'ref'
+highlight_language = 'none'
+extensions = [
+ 'sphinx.ext.intersphinx',
+ ]
+intersphinx_mapping = {
+ 'trytond': (trytond_url.format(series=version), None),
+ }
+intersphinx_mapping.update({
+ m: (modules_url.format(
+ module=m.replace('_', '-'), series=version), None)
+ for m in info['modules']
+ })
+
+del get_info, info, modules_url, trytond_url
diff -r 000000000000 -r 82d9d0a3072c doc/design.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/design.rst Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,34 @@
+******
+Design
+******
+
+The *Sale Product Recommendation Association Rule Module* introduces the
+following concepts.
+
+.. _model-sale.product.association.rule
+
+Product Association Rule
+========================
+
+The model is used to store the rules learned by the system.
+They are composed of antecedents and consequents which are lists of `Products
+<product:concept-product>`.
+The antecedents is that items that can be found in the data while the
+consequents are the items found when combined with the antecedents.
+
+The rule stores also various measures like the *confidence*, *support*, *lift*
+and *conviction*.
+
+.. seealso::
+
+ You can learn more on `association rule learning
+ <https://en.wikipedia.org/wiki/Association_rule_learning>`_
+
+.. seealso::
+
+ Rules are found by opening the menu item:
+
+ |Products --> Products --> Sale Association Rules|__
+
+ .. |Products --> Products --> Sale Association Rules| replace::
:menuselection:`Products --> Products --> Sale Association Rules`
+ __ https://demo.tryton.org/model/sale.product.association.rule
diff -r 000000000000 -r 82d9d0a3072c doc/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,14 @@
+###################################################
+Sale Product Recommendation Association Rule Module
+###################################################
+
+The *Sale Product Recommendation Association Rule Module* implements
+recommendation based on `association rule learning
+<https://en.wikipedia.org/wiki/Association_rule_learning>`_ from previous
+sales.
+
+.. toctree::
+ :maxdepth: 2
+
+ usage
+ design
diff -r 000000000000 -r 82d9d0a3072c doc/usage.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/usage.rst Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,17 @@
+*****
+Usage
+*****
+
+In order to make recommendations the `Product Association Rules
+<model-sale.product.association.rule>` must be computed.
+
+.. _Compute product association rules:
+
+Compute product association rules
+=================================
+
+You may want to schedule the computation of rules based on previous `Sales
+<sale:model-sale.sale>` using a scheduled task *Compute Sale Product
+Association Rules*.
+In order to select the sales used, you must define a delay in the
+`Configuration <sale:model-sale.configuration>`.
diff -r 000000000000 -r 82d9d0a3072c ir.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/ir.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,15 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import PoolMeta
+
+
+class Cron(metaclass=PoolMeta):
+ __name__ = 'ir.cron'
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls.method.selection.append(
+ ('sale.product.association.rule|compute',
+ "Compute Sale Product Association Rules"))
diff -r 000000000000 -r 82d9d0a3072c sale.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sale.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,283 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from itertools import groupby
+
+from efficient_apriori import apriori
+
+from trytond.cache import Cache
+from trytond.model import ModelSQL, ModelView, fields
+from trytond.pool import Pool, PoolMeta
+from trytond.transaction import Transaction
+
+
+class Configuration(metaclass=PoolMeta):
+ __name__ = 'sale.configuration'
+
+ product_association_rule_transactions_up_to = fields.TimeDelta(
+ "Transactions Up to")
+ product_association_rule_min_support = fields.Float(
+ "Minimum Support", required=True,
+ domain=[
+ ('product_association_rule_min_support', '>=', 0),
+ ('product_association_rule_min_support', '<=', 1),
+ ],
+ help="The minimum frequency of which the items in the rule "
+ "appear together in the data set.")
+ product_association_rule_min_confidence = fields.Float(
+ "Minimum Confidence", required=True,
+ domain=[
+ ('product_association_rule_min_confidence', '>=', 0),
+ ('product_association_rule_min_confidence', '<=', 1),
+ ],
+ help="The minimum probability of the rule.")
+ product_association_rule_max_length = fields.Integer(
+ "The maximal number of products for a rule.", required=True,
+ domain=[
+ ('product_association_rule_max_length', '>', 0),
+ ])
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls.product_recommendation_method.selection.append(
+ ('association_rule', "Association Rule"))
+
+ @classmethod
+ def default_product_association_rule_min_support(cls):
+ return 0.3
+
+ @classmethod
+ def default_product_association_rule_min_confidence(cls):
+ return 0.5
+
+ @classmethod
+ def default_product_association_rule_max_length(cls):
+ return 8
+
+
+class Sale(metaclass=PoolMeta):
+ __name__ = 'sale.sale'
+
+ @fields.depends(methods=['_recommended_products_association_rule'])
+ def on_change_with_recommended_products(self, name=None):
+ return super().on_change_with_recommended_products(name=name)
+
+ @fields.depends('lines')
+ def _recommended_products_association_rule(self):
+ pool = Pool()
+ Rule = pool.get('sale.product.association.rule')
+ if self.lines:
+ products = [
+ l.product for l in self.lines
+ if getattr(l, 'product', None)]
+ yield from Rule.recommend(products)
+
+
+class ProductAssociationRule(ModelSQL, ModelView):
+ "Product Association Rule"
+ __name__ = 'sale.product.association.rule'
+
+ antecedents = fields.Many2Many(
+ 'sale.product.association.rule.antecedent', 'rule', 'product',
+ "Antecedents")
+ antecedent_names = fields.Function(fields.Char(
+ "Antecedents"), 'get_product_names')
+ consequents = fields.Many2Many(
+ 'sale.product.association.rule.consequent', 'rule', 'product',
+ "Consequents")
+ consequent_names = fields.Function(fields.Char(
+ "Consequents"), 'get_product_names')
+ confidence = fields.Float(
+ "Confidence",
+ domain=[
+ ('confidence', '>=', 0),
+ ('confidence', '<=', 1),
+ ],
+ help="Probability of consequents, given antecedents.")
+ support = fields.Float(
+ "Support",
+ domain=[
+ ('support', '>=', 0),
+ ('support', '<=', 1),
+ ],
+ help="The frequency of consequents and antecedents appear together.")
+ lift = fields.Float(
+ "Lift", select=True,
+ domain=[
+ ('lift', '>=', 0),
+ ],
+ help="If equals to 1, the two occurrences are "
+ "independent of each other.\n"
+ "If greater than 1, the degree to which the two occurrences are "
+ "dependent on one another.\n"
+ "If less than 1, the items are substitute to each other.")
+ conviction = fields.Float(
+ "Conviction", select=True,
+ domain=[
+ ('conviction', '>=', 0),
+ ],
+ help="The frequency that the rule makes an incorrect prediction.")
+ _find_rules_cache = Cache(__name__ + '._find_rules', context=False)
+
+ def get_product_names(self, name):
+ return ', '.join(
+ p.rec_name for p in getattr(self, name[:-len('_names')] + 's'))
+
+ @classmethod
+ def clean(cls, domain=None):
+ table = cls.__table__()
+ cursor = Transaction().connection.cursor()
+ if domain:
+ query = cls.search(domain, query=True)
+ where = table.id.in_(query)
+ else:
+ where = None
+ cursor.execute(*table.delete(where=where))
+
+ @classmethod
+ def transactions(cls):
+ "Yield transaction as sets of product ids"
+ yield from cls.transactions_sale()
+
+ @classmethod
+ def transactions_sale(cls, domain=None):
+ pool = Pool()
+ Date = pool.get('ir.date')
+ Sale = pool.get('sale.sale')
+ SaleLine = pool.get('sale.line')
+ Configuration = pool.get('sale.configuration')
+
+ config = Configuration(1)
+ today = Date.today()
+ date = today
+ if not config.product_association_rule_transactions_up_to:
+ return
+ date -= config.product_association_rule_transactions_up_to
+
+ lines = SaleLine.search([
+ ('sale.sale_date', '>=', date),
+ ('sale.state', 'not in', ['draft', 'cancelled']),
+ domain or [],
+ ],
+ order=[('sale.id', 'DESC')])
+ for sale, lines in groupby(lines, lambda l: l.sale):
+ yield {
+ l.product.id for l in lines
+ if l.product and Sale._is_recommendable_product(l.product)}
+
+ @classmethod
+ def compute(cls):
+ pool = Pool()
+ Configuration = pool.get('sale.configuration')
+
+ config = Configuration(1)
+ cls.clean()
+ cls._find_rules_cache.clear()
+ transactions = cls.transactions()
+
+ _, rules = apriori(
+ transactions,
+ min_support=config.product_association_rule_min_support,
+ min_confidence=config.product_association_rule_min_confidence,
+ max_length=config.product_association_rule_max_length)
+
+ cls.save([cls.from_rule(rule) for rule in rules])
+
+ @classmethod
+ def from_rule(cls, rule):
+ return cls(
+ antecedents=rule.lhs,
+ consequents=rule.rhs,
+ confidence=rule.confidence,
+ support=rule.support,
+ lift=rule.lift,
+ conviction=rule.conviction)
+
+ @classmethod
+ def _find_rules(cls, products, domain, lift='DESC'):
+ product_ids = {p.id for p in products}
+ key = (sorted(product_ids), domain, lift)
+ rules = cls._find_rules_cache.get(key)
+ if rules is not None:
+ rules = cls.browse(rules)
+ else:
+ rules = cls.search([
+ ('antecedents', 'in', list(product_ids)),
+ domain,
+ ],
+ order=[('lift', lift), ('conviction', 'ASC')])
+ rules = [
+ r for r in rules
+ if set(map(int, r.antecedents)) <= product_ids]
+ cls._find_rules_cache.set(key, [r.id for r in rules])
+
+ products = set(products)
+ for rule in rules:
+ yield from (set(rule.consequents) - products)
+ products.update(rule.consequents)
+
+ @classmethod
+ def recommend(cls, products):
+ return cls._find_rules(products, [('lift', '>', 1)], lift='DESC')
+
+ @classmethod
+ def substitute(cls, products):
+ return cls._find_rules(products, [('lift', '<', 1)], lift='DESC')
+
+
+class ProductAssociationRuleAntecedent(ModelSQL):
+ "Product Association Rule Antecedent"
+ __name__ = 'sale.product.association.rule.antecedent'
+
+ rule = fields.Many2One(
+ 'sale.product.association.rule', "Rule",
+ required=True, select=True, ondelete='CASCADE')
+ product = fields.Many2One(
+ 'product.product', "Product", required=True, ondelete='CASCADE')
+
+
+class ProductAssociationRuleConsequent(ModelSQL):
+ "Product Association Rule Consequent"
+ __name__ = 'sale.product.association.rule.consequent'
+
+ rule = fields.Many2One(
+ 'sale.product.association.rule', "Rule",
+ required=True, select=True, ondelete='CASCADE')
+ product = fields.Many2One(
+ 'product.product', "Product", required=True, ondelete='CASCADE')
+
+
+class ProductAssociationRulePOS(metaclass=PoolMeta):
+ __name__ = 'sale.product.association.rule'
+
+ @classmethod
+ def transactions(cls):
+ yield from super().transactions()
+ yield from cls.transactions_pos()
+
+ @classmethod
+ def transactions_pos(cls, domain=None):
+ pool = Pool()
+ Date = pool.get('ir.date')
+ Sale = pool.get('sale.point.sale')
+ SaleLine = pool.get('sale.point.sale.line')
+ Configuration = pool.get('sale.configuration')
+
+ config = Configuration(1)
+ today = Date.today()
+ date = today
+ if not config.product_association_rule_transactions_up_to:
+ return
+ date -= config.product_association_rule_transactions_up_to
+
+ lines = SaleLine.search([
+ ('sale.date', '>=', date),
+ ('sale.state', 'not in', ['open', 'cancelled']),
+ domain or [],
+ ],
+ order=[('sale.id', 'DESC')])
+ for sale, lines in groupby(lines, lambda l: l.sale):
+ yield {
+ l.product.id for l in lines
+ if l.product and Sale._is_recommendable_product(l.product)}
diff -r 000000000000 -r 82d9d0a3072c sale.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sale.xml Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tryton>
+ <data>
+ <record model="ir.ui.view" id="configuration_view_form">
+ <field name="model">sale.configuration</field>
+ <field name="inherit" ref="sale.sale_configuration_view_form"/>
+ <field name="name">configuration_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="product_association_rule_view_list">
+ <field name="model">sale.product.association.rule</field>
+ <field name="type">tree</field>
+ <field name="name">product_association_rule_list</field>
+ </record>
+
+ <record model="ir.ui.view" id="product_association_rule_view_form">
+ <field name="model">sale.product.association.rule</field>
+ <field name="type">form</field>
+ <field name="name">product_association_rule_form</field>
+ </record>
+
+ <record model="ir.action.act_window"
id="act_product_association_rule_form">
+ <field name="name">Sale Association Rules</field>
+ <field name="res_model">sale.product.association.rule</field>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_product_association_rule_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="product_association_rule_view_list"/>
+ <field name="act_window" ref="act_product_association_rule_form"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_product_association_rule_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="product_association_rule_view_form"/>
+ <field name="act_window" ref="act_product_association_rule_form"/>
+ </record>
+
+ <menuitem
+ parent="sale.menu_product"
+ action="act_product_association_rule_form"
+ sequence="50"
+ id="menu_product_association_rule_form"/>
+
+ <record model="ir.model.access" id="access_product_association_rule">
+ <field name="model" search="[('model', '=',
'sale.product.association.rule')]"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+
+ <record model="ir.cron" id="cron_product_association_rule_compute">
+ <field name="method">sale.product.association.rule|compute</field>
+ <field name="interval_number" eval="1"/>
+ <field name="interval_type">weeks</field>
+ </record>
+ </data>
+</tryton>
diff -r 000000000000 -r 82d9d0a3072c setup.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/setup.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,165 @@
+#!/usr/bin/env python3
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+import io
+import os
+import re
+from configparser import ConfigParser
+
+from setuptools import find_packages, setup
+
+
+def read(fname):
+ content = io.open(
+ os.path.join(os.path.dirname(__file__), fname),
+ 'r', encoding='utf-8').read()
+ content = re.sub(
+ r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
+ return content
+
+
+def get_require_version(name):
+ if minor_version % 2:
+ require = '%s >= %s.%s.dev0, < %s.%s'
+ else:
+ require = '%s >= %s.%s, < %s.%s'
+ require %= (name, major_version, minor_version,
+ major_version, minor_version + 1)
+ return require
+
+
+config = ConfigParser()
+config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg')))
+info = dict(config.items('tryton'))
+for key in ('depends', 'extras_depend', 'xml'):
+ if key in info:
+ info[key] = info[key].strip().splitlines()
+version = info.get('version', '0.0.1')
+major_version, minor_version, _ = version.split('.', 2)
+major_version = int(major_version)
+minor_version = int(minor_version)
+name = 'trytond_sale_product_recommendation_association_rule'
+
+download_url = 'http://downloads.tryton.org/%s.%s/' % (
+ major_version, minor_version)
+if minor_version % 2:
+ version = '%s.%s.dev0' % (major_version, minor_version)
+ download_url = (
+ 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % (
+ name[8:], name, version))
+
+local_version = []
+if os.environ.get('CI_JOB_ID'):
+ local_version.append(os.environ['CI_JOB_ID'])
+else:
+ for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER']:
+ if os.environ.get(build):
+ local_version.append(os.environ[build])
+ else:
+ local_version = []
+ break
+if local_version:
+ version += '+' + '.'.join(local_version)
+requires = ['efficient-apriori']
+for dep in info.get('depends', []):
+ if not re.match(r'(ir|res)(\W|$)', dep):
+ requires.append(get_require_version('trytond_%s' % dep))
+requires.append(get_require_version('trytond'))
+
+tests_require = [
+ get_require_version('proteus'),
+ get_require_version('trytond_sale_point'),
+ ]
+dependency_links = []
+if minor_version % 2:
+ dependency_links.append(
+ 'https://trydevpi.tryton.org/?local_version='
+ + '.'.join(local_version)
+ )
+
+setup(name=name,
+ version=version,
+ description='Tryton module to learn association rule for recommendation',
+ long_description=read('README.rst'),
+ author='Tryton',
+ author_email='[email protected]',
+ url='http://www.tryton.org/',
+ download_url=download_url,
+ project_urls={
+ "Bug Tracker": 'https://bugs.tryton.org/',
+ "Documentation": (
+ 'https://docs.tryton.org/projects/'
+ 'modules-sale-product-recommendation-association-rule'),
+ "Forum": 'https://www.tryton.org/forum',
+ "Source Code": (
+ 'https://hg.tryton.org/modules/'
+ 'sale_product_recommendation_association_rule'),
+ },
+ keywords='tryton sale product recommendation association rule learning',
+ package_dir={
+ 'trytond.modules.sale_product_recommendation_association_rule': '.',
+ },
+ packages=(
+ ['trytond.modules.sale_product_recommendation_association_rule']
+ + ['trytond.modules.'
+ 'sale_product_recommendation_association_rule.%s' % p
+ for p in find_packages()]
+ ),
+ package_data={
+ 'trytond.modules.'
+ 'sale_product_recommendation_association_rule': (info.get('xml', [])
+ + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt',
+ 'icons/*.svg', 'tests/*.rst']),
+ },
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Environment :: Plugins',
+ 'Framework :: Tryton',
+ 'Intended Audience :: Developers',
+ 'Intended Audience :: Financial and Insurance Industry',
+ 'Intended Audience :: Legal Industry',
+ 'License :: OSI Approved :: '
+ 'GNU General Public License v3 or later (GPLv3+)',
+ 'Natural Language :: Bulgarian',
+ 'Natural Language :: Catalan',
+ 'Natural Language :: Chinese (Simplified)',
+ 'Natural Language :: Czech',
+ 'Natural Language :: Dutch',
+ 'Natural Language :: English',
+ 'Natural Language :: Finnish',
+ 'Natural Language :: French',
+ 'Natural Language :: German',
+ 'Natural Language :: Hungarian',
+ 'Natural Language :: Indonesian',
+ 'Natural Language :: Italian',
+ 'Natural Language :: Persian',
+ 'Natural Language :: Polish',
+ 'Natural Language :: Portuguese (Brazilian)',
+ 'Natural Language :: Romanian',
+ 'Natural Language :: Russian',
+ 'Natural Language :: Slovenian',
+ 'Natural Language :: Spanish',
+ 'Natural Language :: Turkish',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: 3.8',
+ 'Programming Language :: Python :: 3.9',
+ 'Programming Language :: Python :: 3.10',
+ 'Programming Language :: Python :: Implementation :: CPython',
+ 'Topic :: Office/Business',
+ ],
+ license='GPL-3',
+ python_requires='>=3.7',
+ install_requires=requires,
+ extras_require={
+ 'test': tests_require,
+ },
+ dependency_links=dependency_links,
+ zip_safe=False,
+ entry_points="""
+ [trytond.modules]
+ sale_product_recommendation_association_rule =
trytond.modules.sale_product_recommendation_association_rule
+ """, # noqa: E501
+ )
diff -r 000000000000 -r 82d9d0a3072c tests/__init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/__init__.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,2 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
diff -r 000000000000 -r 82d9d0a3072c
tests/scenario_sale_product_recommendation_association_rule.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/scenario_sale_product_recommendation_association_rule.rst Wed Sep
14 00:41:29 2022 +0200
@@ -0,0 +1,161 @@
+=====================================================
+Sale Product Recommendation Association Rule Scenario
+=====================================================
+
+Imports::
+
+ >>> import datetime as dt
+ >>> from decimal import Decimal
+
+ >>> from proteus import Model, Wizard
+ >>> from trytond.tests.tools import activate_modules
+ >>> from trytond.modules.company.tests.tools import (
+ ... create_company, get_company)
+
+Activate modules::
+
+ >>> config =
activate_modules('sale_product_recommendation_association_rule')
+
+ >>> Cron = Model.get('ir.cron')
+ >>> Party = Model.get('party.party')
+ >>> ProductTemplate = Model.get('product.template')
+ >>> ProductAssociationRule = Model.get('sale.product.association.rule')
+ >>> Sale = Model.get('sale.sale')
+ >>> SaleConfiguration = Model.get('sale.configuration')
+ >>> Uom = Model.get('product.uom')
+
+Create company::
+
+ >>> _ = create_company()
+ >>> company = get_company()
+
+Configuration association rule::
+
+ >>> sale_config = SaleConfiguration(1)
+ >>> sale_config.product_association_rule_transactions_up_to = (
+ ... dt.timedelta(days=30))
+ >>> sale_config.product_recommendation_method = 'association_rule'
+ >>> sale_config.save()
+
+Create customer::
+
+ >>> customer = Party(name="Customer")
+ >>> customer.save()
+
+Create products::
+
+ >>> unit, = Uom.find([('name', '=', "Unit")])
+
+ >>> template = ProductTemplate()
+ >>> template.name = "Egg"
+ >>> template.default_uom = unit
+ >>> template.type = 'goods'
+ >>> template.salable = True
+ >>> template.recommendable = True
+ >>> template.list_price = Decimal('1')
+ >>> template.save()
+ >>> egg, = template.products
+
+ >>> template = ProductTemplate()
+ >>> template.name = "Bacon"
+ >>> template.default_uom = unit
+ >>> template.type = 'goods'
+ >>> template.salable = True
+ >>> template.recommendable = True
+ >>> template.list_price = Decimal('5')
+ >>> template.save()
+ >>> bacon, = template.products
+
+ >>> template = ProductTemplate()
+ >>> template.name = "Soup"
+ >>> template.default_uom = unit
+ >>> template.type = 'goods'
+ >>> template.salable = True
+ >>> template.recommendable = True
+ >>> template.list_price = Decimal('8')
+ >>> template.save()
+ >>> soup, = template.products
+
+ >>> template = ProductTemplate()
+ >>> template.name = "Apple"
+ >>> template.default_uom = unit
+ >>> template.type = 'goods'
+ >>> template.salable = True
+ >>> template.recommendable = True
+ >>> template.list_price = Decimal('3')
+ >>> template.save()
+ >>> apple, = template.products
+
+ >>> template = ProductTemplate()
+ >>> template.name = "Banana"
+ >>> template.default_uom = unit
+ >>> template.type = 'goods'
+ >>> template.salable = True
+ >>> template.recommendable = True
+ >>> template.list_price = Decimal('4')
+ >>> template.save()
+ >>> banana, = template.products
+
+Create some sales::
+
+ >>> sale = Sale(party=customer)
+ >>> line = sale.lines.new(product=egg)
+ >>> line.quantity = 12
+ >>> line = sale.lines.new(product=bacon)
+ >>> line.quantity = 2
+ >>> line = sale.lines.new(product=soup)
+ >>> line.quantity = 1
+ >>> sale.click('quote')
+ >>> sale.click('confirm')
+ >>> sale.state
+ 'confirmed'
+
+ >>> sale = Sale(party=customer)
+ >>> line = sale.lines.new(product=egg)
+ >>> line.quantity = 6
+ >>> line = sale.lines.new(product=bacon)
+ >>> line.quantity = 4
+ >>> line = sale.lines.new(product=apple)
+ >>> line.quantity = 5
+ >>> sale.click('quote')
+ >>> sale.click('confirm')
+
+ >>> sale = Sale(party=customer)
+ >>> line = sale.lines.new(product=soup)
+ >>> line.quantity = 3
+ >>> line = sale.lines.new(product=bacon)
+ >>> line.quantity = 2
+ >>> line = sale.lines.new(product=banana)
+ >>> line.quantity = 5
+ >>> sale.click('quote')
+ >>> sale.click('confirm')
+
+ >>> sale = Sale(party=customer)
+ >>> line = sale.lines.new(product=apple)
+ >>> line.quantity = 2
+ >>> line = sale.lines.new(product=banana)
+ >>> line.quantity = 2
+ >>> sale.click('quote')
+ >>> sale.click('confirm')
+
+Compute association rules::
+
+ >>> cron_compute_association_rule, = Cron.find([
+ ... ('method', '=', 'sale.product.association.rule|compute'),
+ ... ])
+ >>> cron_compute_association_rule.click('run_once')
+
+ >>> bool(ProductAssociationRule.find([]))
+ True
+
+Test recommended products::
+
+ >>> sale = Sale(party=customer)
+ >>> [p.name for p in sale.recommended_products]
+ []
+ >>> line = sale.lines.new(product=apple)
+ >>> [p.name for p in sale.recommended_products]
+ []
+ >>> line = sale.lines.new(product=egg)
+ >>> [p.name for p in sale.recommended_products]
+ ['Bacon']
diff -r 000000000000 -r 82d9d0a3072c tests/test_module.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test_module.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,12 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+from trytond.tests.test_tryton import ModuleTestCase
+
+
+class SaleProductRecommendationAssociationRuleTestCase(ModuleTestCase):
+ "Test Sale Product Recommendation Association Rule module"
+ module = 'sale_product_recommendation_association_rule'
+ extras = ['sale_point']
+
+
+del ModuleTestCase
diff -r 000000000000 -r 82d9d0a3072c tests/test_scenario.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test_scenario.py Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,8 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.tests.test_tryton import load_doc_tests
+
+
+def load_tests(*args, **kwargs):
+ return load_doc_tests(__name__, __file__, *args, **kwargs)
diff -r 000000000000 -r 82d9d0a3072c tox.ini
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tox.ini Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,17 @@
+[tox]
+envlist = {py37,py38,py39,py310}-{sqlite,postgresql}
+
+[testenv]
+extras = test
+commands =
+ coverage run --include=.*/sale_product_recommendation_association_rule/*
-m unittest discover -s tests
+ coverage report
--include=.*/sale_product_recommendation_association_rule/* --omit=*/tests/*
+deps =
+ coverage
+ postgresql: psycopg2 >= 2.7.0
+setenv =
+ sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://}
+ postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://}
+ sqlite: DB_NAME={env:SQLITE_NAME::memory:}
+ postgresql: DB_NAME={env:POSTGRESQL_NAME:test}
+install_command = pip install --pre --find-links
https://trydevpi.tryton.org/?local_version={env:CI_JOB_ID:{env:CI_BUILD_NUMBER:}.{env:CI_JOB_NUMBER:}}
{opts} {packages}
diff -r 000000000000 -r 82d9d0a3072c tryton.cfg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tryton.cfg Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,11 @@
+[tryton]
+version=6.5.0
+depends:
+ ir
+ product
+ sale
+ sale_product_recommendation
+extras_depend:
+ sale_point
+xml:
+ sale.xml
diff -r 000000000000 -r 82d9d0a3072c view/configuration_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/configuration_form.xml Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<data>
+ <xpath expr="/form" position="inside">
+ <separator string="Product Recommendation Association Rule"
id="product_association_rule" colspan="4"/>
+
+ <label name="product_association_rule_transactions_up_to"/>
+ <field name="product_association_rule_transactions_up_to"/>
+ <label name="product_association_rule_max_length"/>
+ <field name="product_association_rule_max_length"/>
+
+ <label name="product_association_rule_min_support"/>
+ <field name="product_association_rule_min_support"/>
+ <label name="product_association_rule_min_confidence"/>
+ <field name="product_association_rule_min_confidence"/>
+ </xpath>
+</data>
diff -r 000000000000 -r 82d9d0a3072c view/product_association_rule_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/product_association_rule_form.xml Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form col="2">
+ <group col="2" colspan="2" id="rule">
+ <field name="antecedents" view_ids="product.product_view_tree_simple"/>
+ <field name="consequents" view_ids="product.product_view_tree_simple"/>
+ </group>
+
+ <label name="confidence"/>
+ <field name="confidence"/>
+
+ <label name="support"/>
+ <field name="support"/>
+
+ <label name="lift"/>
+ <field name="lift"/>
+
+ <label name="conviction"/>
+ <field name="conviction"/>
+</form>
diff -r 000000000000 -r 82d9d0a3072c view/product_association_rule_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/product_association_rule_list.xml Wed Sep 14 00:41:29 2022 +0200
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree>
+ <field name="antecedent_names" expand="1"/>
+ <field name="consequent_names" expand="1"/>
+ <field name="confidence" optional="1"/>
+ <field name="support" optional="1"/>
+ <field name="lift" optional="1"/>
+ <field name="conviction" optional="1"/>
+</tree>
