├── .gitignore ├── LICENSE ├── README.md ├── fonts └── Roboto-Bold.ttf ├── receipt_generator.py └── sample-out.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # PyCharm 107 | .idea/ 108 | 109 | # MacOS 110 | .DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2019 M Sampath Kumar 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FakeReceiptImageGenerator 2 | 3 | A Simple Receipt Generator using PIL & Python. 4 | 5 | Goal of this repository is provide a basic but extensible template framework for generating Image Receipt of your idea. 6 | 7 | Note: We are using Python 3.6 as our development language. 8 | 9 | # Requirements 10 | 11 | 1. Requires Python PIL Package for generating receipts 12 | 2. Required a Rotofont font in `fonts` folder 13 | 14 | # To Run 15 | 16 | `python3 receipt_generator.py` 17 | 18 | # Road Map 19 | 20 | For details please check - https://github.com/msampathkumar/FakeReceiptImageGenerator/projects/1 21 | 22 | 23 | # Default Sample Output 24 | Following is the sample 25 | ![image](sample-out.png) 26 | 27 | # Licence 28 | Apache License Version 2.0, January 2004 29 | -------------------------------------------------------------------------------- /fonts/Roboto-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/msampathkumar/FakeReceiptImageGenerator/30306c8696ba58203408a93693f49bbed22bdc14/fonts/Roboto-Bold.ttf -------------------------------------------------------------------------------- /receipt_generator.py: -------------------------------------------------------------------------------- 1 | ''' 2 | A Simple Experimental Receipt Generator 3 | ''' 4 | 5 | from PIL import Image, ImageDraw, ImageFont, ImageOps 6 | 7 | 8 | def _insert_text(draw: ImageDraw, x, y, text, 9 | color='rgb(0, 0, 0)', 10 | font_file='fonts/Roboto-Bold.ttf', 11 | font_size=12): 12 | text = str(text) 13 | font = ImageFont.truetype(font_file, size=font_size) 14 | draw.text((x, y), text, fill=color, font=font) 15 | return draw 16 | 17 | 18 | def _combine_all_images_horizantally(images): 19 | # images = map(Image.open, sys.argv[1:-1]) 20 | w = sum(i.size[0] for i in images) 21 | mh = max(i.size[1] for i in images) 22 | 23 | result = Image.new("RGBA", (w, mh)) 24 | 25 | x = 0 26 | for i in images: 27 | result.paste(i, (x, 0)) 28 | x += i.size[0] 29 | return result 30 | 31 | 32 | def _combine_all_images_vertically(images): 33 | # images = map(Image.open, sys.argv[1:-1]) 34 | w = max(i.size[0] for i in images) 35 | mh = sum(i.size[1] for i in images) 36 | 37 | result = Image.new("RGBA", (w, mh)) 38 | 39 | x = 0 40 | for i in images: 41 | result.paste(i, (0, x)) 42 | x += i.size[1] 43 | return result 44 | 45 | 46 | class ReceiptGenerator(): 47 | def __init__(self, size=None): 48 | self.header = None 49 | self.body = None 50 | self.footer = None 51 | self.final_output_image = None 52 | self._debug_ = False # Debug Param 53 | 54 | self.image_size = size if size else (320, 480) 55 | self.image_line_sep = self._text_image('--' * 35, font_size=14, size=self.image_size) 56 | self.image_whitespace_sep = self._text_image(' ', font_size=14, size=self.image_size) 57 | 58 | self.receipt_text_data = [] 59 | 60 | def _text_image(self, text, font_size=12, size=(320, 480)): 61 | width, height = size 62 | _text = text.center(int(int(width / font_size) * 3.2)) 63 | if self._debug_: 64 | _text = _text.replace(' ', '.') 65 | image = Image.new(mode="RGB", size=(width, font_size + 4), color=(255, 255, 255)) 66 | draw = ImageDraw.Draw(image) 67 | draw = _insert_text(draw=draw, x=0 + 4, y=0, text=_text, font_size=font_size) 68 | if self._debug_: 69 | image = ImageOps.expand(image, border=2, fill='black') 70 | return image 71 | 72 | def generate_header(self): 73 | header_text_data = [ 74 | 'Py Merchant Name', 75 | 'Shop is in Okalhama, OA', 76 | '000-123-997', 77 | 'Receipt: 12313', 78 | 'Date: 12/12/2009' 79 | ] 80 | 81 | image1 = _combine_all_images_vertically([ 82 | self._text_image(header_text_data[0], font_size=25, size=(320, 0)), 83 | self._text_image(header_text_data[1], font_size=12, size=(320, 0)), 84 | self._text_image(header_text_data[2], font_size=12, size=(320, 0)), 85 | ] 86 | ) 87 | self.receipt_text_data += header_text_data[:3] 88 | 89 | image2 = _combine_all_images_horizantally([ 90 | self._text_image(header_text_data[3], font_size=12, size=(160, 0)), 91 | self._text_image(header_text_data[4], font_size=12, size=(160, 0)) 92 | ]) 93 | self.receipt_text_data.append(header_text_data[3] + ' ' + header_text_data[4]) 94 | 95 | self.header = _combine_all_images_vertically([image1, image2]) 96 | 97 | def generate_body(self): 98 | body_text_data = [ 99 | ('S.No', 'Item Description', 'Items', 'Cost'), 100 | ('1', 'Chocolate Cake(1 Kg) ', '1', '895.00'), 101 | ('2', 'Flower Bookie', '1', '500.50'), 102 | ('3', 'Rat Poisen(500ml)', '1', ' 50.50'), 103 | ] 104 | 105 | bag = [] 106 | 107 | for each_line in body_text_data: 108 | _image_line_item = _combine_all_images_horizantally([ 109 | self._text_image(each_line[0], font_size=12, size=(40, 0)), 110 | self._text_image(each_line[1], font_size=12, size=(160, 0)), 111 | self._text_image(each_line[2], font_size=12, size=(40, 0)), 112 | self._text_image(each_line[3], font_size=12, size=(80, 0)), 113 | ]) 114 | bag.append(_image_line_item) 115 | self.receipt_text_data.append('{} {} {} {}'.format(*each_line)) 116 | 117 | image3 = _combine_all_images_vertically(bag) 118 | 119 | self.body = image3 120 | 121 | def generate_footer(self): 122 | footer_text_data = [ 123 | (' Tax:', ' 5.15'), 124 | (' GST:', ' 1.15'), 125 | (' SST:', ' 1.15'), 126 | ('Total Tax:', '1299.10'), 127 | ] 128 | 129 | bag = [] 130 | for each_line in footer_text_data: 131 | _image_text = _combine_all_images_horizantally([ 132 | self._text_image('', font_size=14, size=(160, 0)), 133 | self._text_image(each_line[0], font_size=14, size=(80, 0)), 134 | self._text_image(each_line[1], font_size=14, size=(80, 0)) 135 | ]) 136 | bag.append(_image_text) 137 | self.receipt_text_data.append('{} {}'.format(*each_line)) 138 | 139 | self.footer = _combine_all_images_vertically(bag) 140 | 141 | def show_output(self): 142 | pass 143 | 144 | def save_output(self): 145 | self.generate_header() 146 | self.generate_body() 147 | self.generate_footer() 148 | self.final_output_image = _combine_all_images_vertically( 149 | [ 150 | self.image_whitespace_sep, 151 | self.header, 152 | self.image_whitespace_sep, 153 | self.image_line_sep, 154 | self.body, 155 | self.image_line_sep, 156 | self.footer, 157 | self.image_line_sep, 158 | self.image_whitespace_sep, 159 | ] 160 | ) 161 | self.final_output_image.save('sample-out.png') 162 | print(self.receipt_text_data) 163 | 164 | 165 | if __name__ == '__main__': 166 | t = ReceiptGenerator() 167 | t.save_output() -------------------------------------------------------------------------------- /sample-out.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/msampathkumar/FakeReceiptImageGenerator/30306c8696ba58203408a93693f49bbed22bdc14/sample-out.png --------------------------------------------------------------------------------