diff --git a/sequence_check_digit/README.rst b/sequence_check_digit/README.rst index cf849c6..be8a763 100644 --- a/sequence_check_digit/README.rst +++ b/sequence_check_digit/README.rst @@ -1,9 +1,29 @@ -.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg +======================== +Check Digit on Sequences +======================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github + :target: https://github.com/OCA/server-ux/tree/12.0/sequence_check_digit + :alt: OCA/server-ux +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-ux-12-0/server-ux-12-0-sequence_check_digit + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/250/12.0 + :alt: Try me on Runbot -==================== -Sequence Check Digit -==================== +|badge1| |badge2| |badge3| |badge4| |badge5| This module was written to configure check digits on sequences added on the end. It is useful as a control of the number on visual validation. @@ -12,6 +32,11 @@ It is useful when some manual checks are required or on integrations. The implemented codes can avoid modification of one character and flip of two consecutive characters. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -27,25 +52,42 @@ Usage * ISO 7064 Mod 37, 36: [0-9A-Z]* * ISO 7064 Mod 97, 10: [0-9A-Z]* +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + Credits ======= +Authors +~~~~~~~ + +* Creu Blanca + Contributors ------------- +~~~~~~~~~~~~ * Enric Tobella -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-ux `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/sequence_check_digit/__init__.py b/sequence_check_digit/__init__.py index 494cc90..75d7924 100644 --- a/sequence_check_digit/__init__.py +++ b/sequence_check_digit/__init__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). from . import models diff --git a/sequence_check_digit/__manifest__.py b/sequence_check_digit/__manifest__.py index 08573f8..9a2a96a 100644 --- a/sequence_check_digit/__manifest__.py +++ b/sequence_check_digit/__manifest__.py @@ -1,12 +1,11 @@ -# -*- coding: utf-8 -*- # Copyright (C) 2017 Creu Blanca # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). { "name": "Check Digit on Sequences", - "version": "11.0.1.0.0", + "version": "12.0.1.0.0", "category": "Reporting", - "website": "https://github.com/OCA/server-tools", + "website": "https://github.com/OCA/server-ux", "author": "Creu Blanca, " "Odoo Community Association (OCA)", "license": "LGPL-3", diff --git a/sequence_check_digit/models/__init__.py b/sequence_check_digit/models/__init__.py index 9aac8b4..a0d2ff5 100644 --- a/sequence_check_digit/models/__init__.py +++ b/sequence_check_digit/models/__init__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). from . import ir_sequence diff --git a/sequence_check_digit/models/ir_sequence.py b/sequence_check_digit/models/ir_sequence.py index e48efab..4aacd3a 100644 --- a/sequence_check_digit/models/ir_sequence.py +++ b/sequence_check_digit/models/ir_sequence.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright (C) 2017 Creu Blanca # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). diff --git a/sequence_check_digit/readme/CONTRIBUTORS.rst b/sequence_check_digit/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000..93ec993 --- /dev/null +++ b/sequence_check_digit/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Enric Tobella diff --git a/sequence_check_digit/readme/DESCRIPTION.rst b/sequence_check_digit/readme/DESCRIPTION.rst new file mode 100644 index 0000000..a8df669 --- /dev/null +++ b/sequence_check_digit/readme/DESCRIPTION.rst @@ -0,0 +1,6 @@ +This module was written to configure check digits on sequences added on the end. +It is useful as a control of the number on visual validation. + +It is useful when some manual checks are required or on integrations. +The implemented codes can avoid modification of one character and flip of +two consecutive characters. diff --git a/sequence_check_digit/readme/USAGE.rst b/sequence_check_digit/readme/USAGE.rst new file mode 100644 index 0000000..e158a3f --- /dev/null +++ b/sequence_check_digit/readme/USAGE.rst @@ -0,0 +1,11 @@ +* Access sequences and configurate the model to use. +* The model will check if the format of prefix, suffix and number is valid +* Implemented algorithms + * Luhn: [0-9]* + * Damm: [0-9]* + * Verhoeff: [0-9]* + * ISO 7064 Mod 11, 2: [0-9]* + * ISO 7064 Mod 11, 10: [0-9]* + * ISO 7064 Mod 37, 2: [0-9A-Z]* + * ISO 7064 Mod 37, 36: [0-9A-Z]* + * ISO 7064 Mod 97, 10: [0-9A-Z]* diff --git a/sequence_check_digit/tests/__init__.py b/sequence_check_digit/tests/__init__.py index db229c3..d810180 100644 --- a/sequence_check_digit/tests/__init__.py +++ b/sequence_check_digit/tests/__init__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). from . import test_check_digit diff --git a/sequence_check_digit/tests/test_check_digit.py b/sequence_check_digit/tests/test_check_digit.py index 9725600..d469098 100644 --- a/sequence_check_digit/tests/test_check_digit.py +++ b/sequence_check_digit/tests/test_check_digit.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2017 Creu Blanca # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).