diff --git a/.gitlab-ci-modules.yml b/.gitlab-ci-modules.yml index 258eefb7a5..09a410cff6 100644 --- a/.gitlab-ci-modules.yml +++ b/.gitlab-ci-modules.yml @@ -1759,6 +1759,28 @@ test-modules-document_incoming_ocr-postgresql: PACKAGE: modules/document_incoming_ocr TAG_PATTERN: '/^document_incoming_ocr-.*/' +check-doc-modules-document_incoming_ocr_typless: + extends: .check-doc + variables: + PACKAGE: modules/document_incoming_ocr_typless + +trigger-doc-build-modules-document_incoming_ocr_typless: + extends: .trigger-doc-build + variables: + PACKAGE: modules/document_incoming_ocr_typless + +test-modules-document_incoming_ocr_typless-sqlite: + extends: .test-sqlite + variables: + PACKAGE: modules/document_incoming_ocr_typless + TAG_PATTERN: '/^document_incoming_ocr_typless-.*/' + +test-modules-document_incoming_ocr_typless-postgresql: + extends: .test-postgresql + variables: + PACKAGE: modules/document_incoming_ocr_typless + TAG_PATTERN: '/^document_incoming_ocr_typless-.*/' + check-doc-modules-edocument_uncefact: extends: .check-doc variables: diff --git a/modules/document_incoming_ocr_typless/.readthedocs.yaml b/modules/document_incoming_ocr_typless/.readthedocs.yaml new file mode 100644 index 0000000000..3a32960b3b --- /dev/null +++ b/modules/document_incoming_ocr_typless/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3" +python: + install: + - requirements: modules/document_incoming_ocr_typless/doc/requirements-doc.txt +sphinx: + configuration: modules/document_incoming_ocr_typless/doc/conf.py diff --git a/modules/document_incoming_ocr_typless/CHANGELOG b/modules/document_incoming_ocr_typless/CHANGELOG new file mode 100644 index 0000000000..e69de29bb2 diff --git a/modules/document_incoming_ocr_typless/COPYRIGHT b/modules/document_incoming_ocr_typless/COPYRIGHT new file mode 100644 index 0000000000..b8a4ebd40a --- /dev/null +++ b/modules/document_incoming_ocr_typless/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2023 B2CK +Copyright (C) 2023 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 . diff --git a/modules/document_incoming_ocr_typless/LICENSE b/modules/document_incoming_ocr_typless/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/modules/document_incoming_ocr_typless/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/modules/document_incoming_ocr_typless/MANIFEST.in b/modules/document_incoming_ocr_typless/MANIFEST.in new file mode 100644 index 0000000000..f7e7aaa36b --- /dev/null +++ b/modules/document_incoming_ocr_typless/MANIFEST.in @@ -0,0 +1,6 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +include icons/LICENSE +graft doc diff --git a/modules/document_incoming_ocr_typless/README.rst b/modules/document_incoming_ocr_typless/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/modules/document_incoming_ocr_typless/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/modules/document_incoming_ocr_typless/__init__.py b/modules/document_incoming_ocr_typless/__init__.py new file mode 100644 index 0000000000..bfe4c27171 --- /dev/null +++ b/modules/document_incoming_ocr_typless/__init__.py @@ -0,0 +1,14 @@ +# 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 document + +__all__ = ['register'] + + +def register(): + Pool.register( + document.IncomingOCRService, + module='document_incoming_ocr_typless', type_='model') diff --git a/modules/document_incoming_ocr_typless/doc/conf.py b/modules/document_incoming_ocr_typless/doc/conf.py new file mode 100644 index 0000000000..818c9e9f8c --- /dev/null +++ b/modules/document_incoming_ocr_typless/doc/conf.py @@ -0,0 +1,88 @@ +# 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 os + +base_url = os.environ.get('DOC_BASE_URL') +if base_url: + modules_url = base_url + '/modules-{module}/' + trytond_url = base_url + '/server/' +else: + 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 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', '--description'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'], info['description'] = ( + result.stdout.decode('utf-8').strip().splitlines()) + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + major_version, minor_version, _ = version.split('.', 2) + major_version = int(major_version) + minor_version = int(minor_version) + if minor_version % 2: + info['series'] = 'latest' + info['branch'] = 'branch/default' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + info['branch'] = 'branch/' + info['series'] + + 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() + +html_theme = 'sphinx_book_theme' +html_theme_options = { + 'repository_provider': 'gitlab', + 'repository_url': 'https://code.tryton.org/tryton', + 'repository_branch': info['branch'], + 'use_source_button': True, + 'use_edit_page_button': True, + 'use_repository_button': True, + 'use_download_button': False, + 'path_to_docs': 'modules/document_incoming_ocr_typless/doc', + } +html_title = info['description'] +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx_copybutton', + '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'] + }) +linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*'] + +del get_info, info, base_url, modules_url, trytond_url diff --git a/modules/document_incoming_ocr_typless/doc/index.rst b/modules/document_incoming_ocr_typless/doc/index.rst new file mode 100644 index 0000000000..a762862acb --- /dev/null +++ b/modules/document_incoming_ocr_typless/doc/index.rst @@ -0,0 +1,12 @@ +#################################### +Document Incoming OCR Typless Module +#################################### + +The *Document Incoming OCR Typless Module* provides integration with `Typless +`_ services. + +.. toctree:: + :maxdepth: 2 + + setup + releases diff --git a/modules/document_incoming_ocr_typless/doc/releases.rst b/modules/document_incoming_ocr_typless/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/document_incoming_ocr_typless/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/document_incoming_ocr_typless/doc/requirements-doc.txt b/modules/document_incoming_ocr_typless/doc/requirements-doc.txt new file mode 100644 index 0000000000..fee3b273bd --- /dev/null +++ b/modules/document_incoming_ocr_typless/doc/requirements-doc.txt @@ -0,0 +1,2 @@ +sphinx_book_theme +sphinx_copybutton diff --git a/modules/document_incoming_ocr_typless/doc/setup.rst b/modules/document_incoming_ocr_typless/doc/setup.rst new file mode 100644 index 0000000000..1cc6d75560 --- /dev/null +++ b/modules/document_incoming_ocr_typless/doc/setup.rst @@ -0,0 +1,85 @@ +***** +Setup +***** + +.. _Configure Typeless service: + +Configure Typless service +========================= + +First you must `register to Typless `_ and retrieve +the API key from your profile. + +Then create a document type and configured it for the `Incoming Documents +` you want to process + +When setting the `OCR Service +`'s type to +:guilabel:`Typless`, you must fill in the :guilabel:`API Key` with the key and +:guilabel:`Document Type` with the name of the document type created. You can +fill if needed the selection criteria. + + +.. _Setup fields for Unknown type: + +Setup fields for Unknown type +============================= + +To process `Incoming Documents ` +with :guilabel:`Unknown` type, you should add the metadata field: + + - ``document_type``: ``Constant`` + +.. _Setup fields for Supplier Invoice type: + +Setup fields for Supplier Invoice type +====================================== + +To process `Incoming Documents ` +with :guilabel:`Supplier Invoice` type, you may add the metadata fields: + + - ``company_name``: ``String`` (optional) + + - ``company_tax_identifier``: ``String`` (optional) + + - ``supplier_name``: ``String`` + + - ``tax_identifier``: ``String`` (optional) + + - ``currency``: ``Constant`` (optional) + + - ``number``: ``String`` (optional) + + - ``description``: ``String`` (optional) + + - ``invoice_date``: ``Date`` (optional) + + - ``payment_term_date``: ``Date`` (optional) + + - ``total_amount``: ``Number`` + + - ``untaxed_amount``: ``Number`` (optional) + + - ``tax_amount``: ``Number`` (optional) + + - ``purchase_orders``: ``String`` (optional) + +If you want to process also the invoice lines, you may add the line item fields: + + - ``product_name``: ``String`` (optional) + + - ``description``: ``String`` + + - ``unit``: ``String`` (optional) + + - ``quantity``: ``Number`` + + - ``unit_price``: ``Number`` (optional if ``amount`` is set) + + - ``amount``: ``Number`` (optional if ``unit_price`` is set) + + - ``purchase_order``: ``String`` (optional) + +You can also active the "Vat rate net plugin" with ``untaxed_amount`` as +:guilabel:`Net amount field` and ``total_amount`` as :guilabel:`Gross amount +field`. diff --git a/modules/document_incoming_ocr_typless/document.py b/modules/document_incoming_ocr_typless/document.py new file mode 100644 index 0000000000..2b9c8bde67 --- /dev/null +++ b/modules/document_incoming_ocr_typless/document.py @@ -0,0 +1,322 @@ +# 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 base64 +from decimal import Decimal +from functools import wraps + +import requests + +from trytond.i18n import gettext +from trytond.model import fields +from trytond.pool import PoolMeta +from trytond.pyson import Eval + +from .exceptions import TyplessError + +MIME_TYPES = { + 'application/pdf', + 'image/jpeg', + 'image/png', + 'image/tiff', + } +EXTRACT_DATA = 'https://developers.typless.com/api/extract-data' +ADD_DOCUMENT_FEEDBACK = ( + 'https://developers.typless.com/api/add-document-feedback') + + +def typless_api(func): + @wraps(func) + def wrapper(*args, **kwargs): + try: + return func(*args, **kwargs) + except requests.HTTPError as e: + error_message = e.args[0] + raise TyplessError( + gettext('document_incoming_ocr_typless' + '.msg_typless_webserver_error', + message=error_message)) + return wrapper + + +def get_best_value(fields, name): + for field in fields: + if field.get('name') == name: + break + else: + return + values = field.get('values', []) + values = sorted( + values, key=lambda v: v.get('confidence_score'), reverse=True) + if values: + return values[0].get('value') + + +class IncomingOCRService(metaclass=PoolMeta): + __name__ = 'document.incoming.ocr.service' + + _states = { + 'required': Eval('type') == 'typless', + 'invisible': Eval('type') != 'typless', + } + + typless_api_key = fields.Char( + "API Key", states=_states, + help="The standard token from Typless settings page.") + typless_document_type = fields.Char( + "Document Type", states=_states, + help="The name of the document type on Typless.") + + @classmethod + def __setup__(cls): + super().__setup__() + cls.type.selection.append(('typless', "Typless")) + + def match_mime_type(self, mime_type): + match = super().match_mime_type(mime_type) + if self.type == 'typless': + match = mime_type in MIME_TYPES + return match + + @typless_api + def _process_typless(self, document): + payload = self._typless_extract_payload(document) + headers = { + 'Accept': 'application/json', + 'Content-Type': 'application/json', + 'Authorization': self.typless_api_key, + } + response = requests.post(EXTRACT_DATA, json=payload, headers=headers) + response.raise_for_status() + return response.json() + + def _typless_extract_payload(self, document): + return { + 'file': base64.b64encode(document.data).decode('utf-8'), + 'file_name': document.name, + 'document_type_name': self.typless_document_type, + } + + def _get_document_incoming_typless(self, document): + document_data = {} + if not document.parsed_data: + return document_data + fields = document.parsed_data.get('extracted_fields', []) + document_type = get_best_value(fields, 'document_type') + if document_type is not None: + document_data['document_type'] = document_type + return document_data + + def _get_supplier_invoice_typless(self, document): + invoice_data = {} + if not document.parsed_data: + return invoice_data + fields = document.parsed_data.get('extracted_fields', []) + for name in [ + 'company_name', 'company_tax_identifier', 'supplier_name', + 'tax_identifier', 'currency', 'number', 'description', + 'invoice_date', 'payment_term_date', 'total_amount', + 'purchase_orders']: + value = get_best_value(fields, name) + if value is not None: + if name == 'total_amount': + value = Decimal(value) + invoice_data[name] = value + invoice_data['lines'] = lines = [] + for parsed_line in document.parsed_data.get('line_items', []): + lines.append(self._get_supplier_invoice_typless_line( + parsed_line, invoice_data)) + invoice_data['taxes'] = taxes = [] + for parsed_tax in document.parsed_data.get('vat_rates', []): + taxes.append(self._get_supplier_invoice_typless_tax( + parsed_tax, invoice_data)) + return invoice_data + + def _get_supplier_invoice_typless_line(self, parsed_line, invoice_data): + line = {} + if 'purchase_orders' in invoice_data: + line['purchase_orders'] = invoice_data['purchase_orders'] + for name in [ + 'product_name', 'description', 'unit', 'quantity', + 'unit_price', 'amount', 'purchase_order']: + value = get_best_value(parsed_line, name) + if value is not None: + if name in {'unit_price', 'amount'}: + value = Decimal(value) + elif name == 'quantity': + value = float(value) + line[name] = value + return line + + def _get_supplier_invoice_typless_tax(sef, parsed_tax, invoice_data): + tax = {'type': 'percentage'} + percentage = get_best_value(parsed_tax, 'vat_rate_percentage') + if percentage is not None: + tax['rate'] = Decimal(percentage) / 100 + net = get_best_value(parsed_tax, 'vat_rate_net') + if net is not None: + tax['base'] = Decimal(net) + return tax + + @typless_api + def _send_feedback_typless(self, document): + payload = self._typless_feedback_payload(document) + headers = { + 'Accept': 'application/json', + 'Content-Type': 'application/json', + 'Authorization': self.typless_api_key, + } + response = requests.post( + ADD_DOCUMENT_FEEDBACK, json=payload, headers=headers) + response.raise_for_status() + + def _typless_feedback_payload(self, document): + source = document.result + fields = document.parsed_data.get('extracted_fields', []) + learning_fields = [] + getter = getattr(self, f'_typless_feedback_payload_{document.type}') + for field in fields: + name = field['name'] + value = getter(source, name) + if value is None: + value = get_best_value(fields, name) + learning_fields.append({ + 'name': name, + 'value': value, + }) + payload = { + 'document_type_name': self.typless_document_type, + 'document_object_id': document.parsed_data['object_id'], + 'learning_fields': learning_fields, + } + line_items = document.parsed_data.get('line_items') + if line_items is not None: + lines = [] + getter = getattr( + self, f'_typless_feedback_payload_line_items_{document.type}') + for i, line_item in enumerate(line_items): + line = [] + for field in line_item: + name = field['name'] + value = getter(i, name, source) + if value is None: + value = get_best_value(line_item, name) + line.append({ + 'name': name, + 'value': value, + }) + lines.append(line) + payload['line_items'] = lines + vat_rates = document.parsed_data.get('vat_rates') + if vat_rates is not None: + taxes = [] + getter = getattr( + self, f'_typless_feedback_payload_vat_rates_{document.type}') + for i, vat_rate in enumerate(vat_rates): + percentage = getter(i, 'vat_rate_percentage', source) + if percentage is None: + percentage = get_best_value( + vat_rate, 'vat_rate_percentage') + net = getter(i, 'vat_rate_net', source) + if net is None: + net = get_best_value(vat_rate, 'vat_rate_net') + taxes.append([{ + 'name': 'vat_rate_percentage', + 'value': percentage, + }, { + 'name': 'vat_rate_net', + 'value': net, + }]) + payload['vat_rates'] = taxes + return payload + + def _typless_feedback_payload_document_incoming(self, document, name): + if name == 'document_type': + return document.type + + def _typless_feedback_payload_line_items_document_incoming( + self, index, name, document): + pass + + def _typless_feedback_payload_vat_rates_document_incoming( + self, index, name, document): + pass + + def _typless_feedback_payload_supplier_invoice(self, invoice, name): + if name == 'company_name': + return invoice.company.party.name + elif name == 'company_tax_identifier': + if invoice.tax_identifier: + return invoice.tax_identifier.code + else: + return '' + elif name == 'supplier_name': + return invoice.party.name + elif name == 'tax_identifier': + if invoice.party_tax_identifier: + return invoice.party_tax_identifier.code + else: + return '' + elif name == 'currency': + return invoice.currency.code + elif name == 'number': + return invoice.reference + elif name == 'description': + return invoice.description + elif name == 'invoice_date': + return invoice.invoice_date.isoformat() + elif name == 'payment_term_date': + if invoice.payment_term_date: + return invoice.payment_term_date.isoformat() + else: + return '' + elif name == 'untaxed_amount': + return str(invoice.untaxed_amount) + elif name == 'tax_amount': + return str(invoice.tax_amount) + elif name == 'total_amount': + return str(invoice.total_amount) + elif name == 'purchase_orders': + return invoice.origins + + def _typless_feedback_payload_line_items_supplier_invoice( + self, index, name, invoice): + lines = [l for l in invoice.lines if l.type == 'line'] + try: + line = lines[index] + except IndexError: + return '' + if name == 'product_name': + if line.product: + return line.product.name + else: + return '' + elif name == 'description': + return line.description + elif name == 'unit': + if line.unit: + return line.unit.name + else: + return '' + elif name == 'quantity': + return str(line.quantity) + elif name == 'unit_price': + return str(line.unit_price) + elif name == 'amount': + return str(line.amount) + elif name == 'purchase_order': + return line.origin_name + + def _typless_feedback_payload_vat_rates_supplier_invoice( + self, index, name, invoice): + try: + line = invoice.taxes[index] + except IndexError: + return '' + if name == 'vat_rate_percentage': + if line.tax and line.tax.type == 'percentage': + return str(line.tax.rate * 100) + else: + return '' + elif name == 'vat_rate_net': + return str(line.base) diff --git a/modules/document_incoming_ocr_typless/document.xml b/modules/document_incoming_ocr_typless/document.xml new file mode 100644 index 0000000000..e3a8d3bab2 --- /dev/null +++ b/modules/document_incoming_ocr_typless/document.xml @@ -0,0 +1,12 @@ + + + + + + document.incoming.ocr.service + + document_incoming_ocr_service_form + + + diff --git a/modules/document_incoming_ocr_typless/exceptions.py b/modules/document_incoming_ocr_typless/exceptions.py new file mode 100644 index 0000000000..0d77cf5ec7 --- /dev/null +++ b/modules/document_incoming_ocr_typless/exceptions.py @@ -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.exceptions import UserError + + +class TyplessError(UserError): + pass diff --git a/modules/document_incoming_ocr_typless/message.xml b/modules/document_incoming_ocr_typless/message.xml new file mode 100644 index 0000000000..9d7b4c264e --- /dev/null +++ b/modules/document_incoming_ocr_typless/message.xml @@ -0,0 +1,11 @@ + + + + + + Typless webservice call failed with the following error message: +%(message)s + + + diff --git a/modules/document_incoming_ocr_typless/setup.py b/modules/document_incoming_ocr_typless/setup.py new file mode 100755 index 0000000000..7a9749f8f6 --- /dev/null +++ b/modules/document_incoming_ocr_typless/setup.py @@ -0,0 +1,137 @@ +#!/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): + 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_document_incoming_ocr_typless' + +if minor_version % 2: + download_url = '' +else: + download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) + +requires = ['requests'] +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_document_incoming_invoice'), + ] + +setup(name=name, + version=version, + description=( + 'Tryton module that integrates Typless OCR for incoming document'), + long_description=read('README.rst'), + author='Tryton', + author_email='foundation@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": ( + 'https://docs.tryton.org/projects/' + 'modules-document-incoming-ocr-typless'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://code.tryton.org/tryton', + }, + keywords='tryton document incoming OCR Typless', + package_dir={'trytond.modules.document_incoming_ocr_typless': '.'}, + packages=( + ['trytond.modules.document_incoming_ocr_typless'] + + ['trytond.modules.document_incoming_ocr_typless.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.document_incoming_ocr_typless': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + 'icons/*.svg', 'tests/*.rst', 'tests/*.pdf']), + }, + 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', + 'Natural Language :: Ukrainian', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: Implementation :: CPython', + 'Topic :: Office/Business', + ], + license='GPL-3', + python_requires='>=3.8', + install_requires=requires, + extras_require={ + 'test': tests_require, + }, + zip_safe=False, + entry_points=""" + [trytond.modules] + document_incoming_ocr_typless = trytond.modules.document_incoming_ocr_typless + """, # noqa: E501 + ) diff --git a/modules/document_incoming_ocr_typless/tests/__init__.py b/modules/document_incoming_ocr_typless/tests/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tests/__init__.py @@ -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 --git a/modules/document_incoming_ocr_typless/tests/scenario_document_incoming_ocr_typless.rst b/modules/document_incoming_ocr_typless/tests/scenario_document_incoming_ocr_typless.rst new file mode 100644 index 0000000000..827d3bcdf3 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tests/scenario_document_incoming_ocr_typless.rst @@ -0,0 +1,139 @@ +====================================== +Document Incoming OCR Typless Scenario +====================================== + +Imports:: + + >>> import os + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.tests.tools import activate_modules + >>> from trytond.tools import file_open + >>> from trytond.modules.account.tests.tools import ( + ... create_chart, create_fiscalyear, get_accounts, create_tax) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + +Activate modules:: + + >>> config = activate_modules([ + ... 'document_incoming_ocr_typless', + ... 'document_incoming_invoice']) + + >>> Document = Model.get('document.incoming') + >>> OCRService = Model.get('document.incoming.ocr.service') + >>> Party = Model.get('party.party') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> UoM = Model.get('product.uom') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create chart of account:: + + >>> _ = create_chart() + >>> accounts = get_accounts(company) + +Create taxes:: + + >>> tax_10 = create_tax(Decimal('0.1'), company) + >>> tax_10.save() + >>> tax_20 = create_tax(Decimal('0.2'), company) + >>> tax_20.save() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences(create_fiscalyear()) + >>> fiscalyear.click('create_period') + +Set default supplier:: + + >>> suppplier = Party(name="Saber") + >>> suppplier.save() + +Create account category:: + + >>> account_category = ProductCategory(name="Accounting") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.save() + +Create product:: + + >>> hour, = UoM.find([('name', '=', "Hour")]) + >>> template = ProductTemplate(name="Service") + >>> template.default_uom = hour + >>> template.type = 'service' + >>> template.account_category = account_category + >>> template.save() + >>> service, = template.products + +Setup Typless service:: + + >>> ocr_service = OCRService(type='typless') + >>> ocr_service.typless_api_key = os.getenv('TYPLESS_API_KEY') + >>> ocr_service.typless_document_type = os.getenv('TYPLESS_DOCUMENT_TYPE') + >>> ocr_service.save() + +Create incoming document:: + + >>> document = Document() + >>> document.name = 'invoice.pdf' + >>> with file_open( + ... 'document_incoming_ocr_typless/tests/' + ... 'supplier-invoice-sample.pdf', + ... mode='rb') as fp: + ... document.data = fp.read() + >>> document.type = 'supplier_invoice' + >>> document.save() + +Process document:: + + >>> document.click('process') + >>> invoice = document.result + >>> invoice.party == suppplier + True + >>> invoice.reference + 'INV-0007' + >>> invoice.invoice_date + datetime.date(2023, 6, 28) + >>> invoice.payment_term_date + datetime.date(2023, 7, 28) + >>> len(invoice.lines) + 2 + >>> line_service, = [l for l in invoice.lines if l.product] + >>> line_service.product == service + True + >>> line_service.quantity + 23.0 + >>> line_service.unit_price + Decimal('2.5000') + >>> line_goods, = [l for l in invoice.lines if not l.product] + >>> line_goods.quantity + 40.0 + >>> line_goods.unit_price + Decimal('5.0000') + >>> len(invoice.taxes) + 2 + >>> sorted([t.amount for t in invoice.taxes]) + [Decimal('5.75'), Decimal('40.00')] + >>> sorted([t.base for t in invoice.taxes]) + [Decimal('57.50'), Decimal('200.00')] + >>> {t.tax for t in invoice.taxes} == {tax_10, tax_20} + True + >>> invoice.untaxed_amount + Decimal('257.50') + >>> invoice.tax_amount + Decimal('45.75') + >>> invoice.total_amount + Decimal('303.25') + +Send feedback:: + + >>> document.click('ocr_send_feedback') diff --git a/modules/document_incoming_ocr_typless/tests/supplier-invoice-sample.pdf b/modules/document_incoming_ocr_typless/tests/supplier-invoice-sample.pdf new file mode 100644 index 0000000000..cab3be9422 Binary files /dev/null and b/modules/document_incoming_ocr_typless/tests/supplier-invoice-sample.pdf differ diff --git a/modules/document_incoming_ocr_typless/tests/test_module.py b/modules/document_incoming_ocr_typless/tests/test_module.py new file mode 100644 index 0000000000..e2c7044b92 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tests/test_module.py @@ -0,0 +1,29 @@ +# 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 trytond.tests.test_tryton import ModuleTestCase, with_transaction + + +class DocumentIncomingOcrTyplessTestCase(ModuleTestCase): + "Test Document Incoming Ocr Typless module" + module = 'document_incoming_ocr_typless' + + @with_transaction() + def test_service_match(self): + "Test Service match" + pool = Pool() + Service = pool.get('document.incoming.ocr.service') + + for service, pattern, result in [ + (Service(type='typless', source=None), {}, False), + (Service(type='typless', source=None), + {'mime_type': 'application/pdf'}, True), + (Service(type='typless', source=None), + {'mime_type': 'application/octet-stream'}, False), + ]: + with self.subTest(service=service, pattern=pattern): + self.assertEqual(service.match(pattern), result) + + +del ModuleTestCase diff --git a/modules/document_incoming_ocr_typless/tests/test_scenario.py b/modules/document_incoming_ocr_typless/tests/test_scenario.py new file mode 100644 index 0000000000..6c3e2b0556 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tests/test_scenario.py @@ -0,0 +1,11 @@ +# 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 os + +from trytond.tests.test_tryton import load_doc_tests + +if (os.getenv('TYPLESS_API_KEY') + and os.getenv('TYPLESS_DOCUMENT_TYPE')): + def load_tests(*args, **kwargs): + return load_doc_tests(__name__, __file__, *args, **kwargs) diff --git a/modules/document_incoming_ocr_typless/tox.ini b/modules/document_incoming_ocr_typless/tox.ini new file mode 100644 index 0000000000..d9777ba257 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tox.ini @@ -0,0 +1,21 @@ +[tox] +envlist = {py38,py39,py310,py311}-{sqlite,postgresql} + +[testenv] +usedevelop = true +extras = test +commands = + coverage run --omit=*/tests/* -m xmlrunner discover -s tests {posargs} +commands_post = + coverage report + coverage xml +deps = + coverage + unittest-xml-reporting + postgresql: psycopg2 >= 2.7.0 +passenv = * +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:DB_NAME::memory:} + postgresql: DB_NAME={env:DB_NAME:test} diff --git a/modules/document_incoming_ocr_typless/tryton.cfg b/modules/document_incoming_ocr_typless/tryton.cfg new file mode 100644 index 0000000000..1b66b6c704 --- /dev/null +++ b/modules/document_incoming_ocr_typless/tryton.cfg @@ -0,0 +1,13 @@ +[tryton] +version=6.9.0 +depends: + currency + document_incoming + document_incoming_ocr + ir + party +extras_depend: + document_incoming_invoice +xml: + document.xml + message.xml diff --git a/modules/document_incoming_ocr_typless/view/document_incoming_ocr_service_form.xml b/modules/document_incoming_ocr_typless/view/document_incoming_ocr_service_form.xml new file mode 100644 index 0000000000..db7614562e --- /dev/null +++ b/modules/document_incoming_ocr_typless/view/document_incoming_ocr_service_form.xml @@ -0,0 +1,13 @@ + + + + + + +