├── .gitignore ├── .vscode └── settings.json ├── COPYING.MPL ├── LICENSE ├── Pipfile ├── Pipfile.lock ├── README.md ├── docs ├── UNO_Interprocess_Connections_DevelopersGuide_OOo3.1.0.pdf ├── insp │ ├── helloworld.py │ └── soffice_connect.py └── usefull-references.md ├── examples └── saved │ ├── somefile.jpg │ ├── somefile.ods │ ├── somefile.pdf │ ├── somefile.png │ ├── somefile.xls │ └── somefile.xlsx ├── libreoffice_py ├── __init__.py ├── config.py ├── document.py ├── libreoffice.py ├── libreoffice_process.py └── utils.py ├── lo_config.toml ├── setup.py └── test ├── test.py ├── test_save_pdf.py ├── testfile.ods └── testfile.pdf /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "code-runner.executorMap": { 3 | "python": "pipenv run python $fullFileName", 4 | } 5 | } -------------------------------------------------------------------------------- /COPYING.MPL: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.python.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | toml = "*" 8 | 9 | [dev-packages] 10 | pylint = "*" 11 | 12 | [requires] 13 | python_version = "3.8" 14 | -------------------------------------------------------------------------------- /Pipfile.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_meta": { 3 | "hash": { 4 | "sha256": "24ba6e842ec5e342bae9801883e34c79a26aaab4e38183f55a8f1731b8b9a416" 5 | }, 6 | "pipfile-spec": 6, 7 | "requires": { 8 | "python_version": "3.8" 9 | }, 10 | "sources": [ 11 | { 12 | "name": "pypi", 13 | "url": "https://pypi.python.org/simple", 14 | "verify_ssl": true 15 | } 16 | ] 17 | }, 18 | "default": { 19 | "toml": { 20 | "hashes": [ 21 | "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", 22 | "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f" 23 | ], 24 | "index": "pypi", 25 | "version": "==0.10.2" 26 | } 27 | }, 28 | "develop": { 29 | "astroid": { 30 | "hashes": [ 31 | "sha256:2f4078c2a41bf377eea06d71c9d2ba4eb8f6b1af2135bec27bbbb7d8f12bb703", 32 | "sha256:bc58d83eb610252fd8de6363e39d4f1d0619c894b0ed24603b881c02e64c7386" 33 | ], 34 | "version": "==2.4.2" 35 | }, 36 | "isort": { 37 | "hashes": [ 38 | "sha256:dcab1d98b469a12a1a624ead220584391648790275560e1a43e54c5dceae65e7", 39 | "sha256:dcaeec1b5f0eca77faea2a35ab790b4f3680ff75590bfcb7145986905aab2f58" 40 | ], 41 | "version": "==5.6.4" 42 | }, 43 | "lazy-object-proxy": { 44 | "hashes": [ 45 | "sha256:0c4b206227a8097f05c4dbdd323c50edf81f15db3b8dc064d08c62d37e1a504d", 46 | "sha256:194d092e6f246b906e8f70884e620e459fc54db3259e60cf69a4d66c3fda3449", 47 | "sha256:1be7e4c9f96948003609aa6c974ae59830a6baecc5376c25c92d7d697e684c08", 48 | "sha256:4677f594e474c91da97f489fea5b7daa17b5517190899cf213697e48d3902f5a", 49 | "sha256:48dab84ebd4831077b150572aec802f303117c8cc5c871e182447281ebf3ac50", 50 | "sha256:5541cada25cd173702dbd99f8e22434105456314462326f06dba3e180f203dfd", 51 | "sha256:59f79fef100b09564bc2df42ea2d8d21a64fdcda64979c0fa3db7bdaabaf6239", 52 | "sha256:8d859b89baf8ef7f8bc6b00aa20316483d67f0b1cbf422f5b4dc56701c8f2ffb", 53 | "sha256:9254f4358b9b541e3441b007a0ea0764b9d056afdeafc1a5569eee1cc6c1b9ea", 54 | "sha256:9651375199045a358eb6741df3e02a651e0330be090b3bc79f6d0de31a80ec3e", 55 | "sha256:97bb5884f6f1cdce0099f86b907aa41c970c3c672ac8b9c8352789e103cf3156", 56 | "sha256:9b15f3f4c0f35727d3a0fba4b770b3c4ebbb1fa907dbcc046a1d2799f3edd142", 57 | "sha256:a2238e9d1bb71a56cd710611a1614d1194dc10a175c1e08d75e1a7bcc250d442", 58 | "sha256:a6ae12d08c0bf9909ce12385803a543bfe99b95fe01e752536a60af2b7797c62", 59 | "sha256:ca0a928a3ddbc5725be2dd1cf895ec0a254798915fb3a36af0964a0a4149e3db", 60 | "sha256:cb2c7c57005a6804ab66f106ceb8482da55f5314b7fcb06551db1edae4ad1531", 61 | "sha256:d74bb8693bf9cf75ac3b47a54d716bbb1a92648d5f781fc799347cfc95952383", 62 | "sha256:d945239a5639b3ff35b70a88c5f2f491913eb94871780ebfabb2568bd58afc5a", 63 | "sha256:eba7011090323c1dadf18b3b689845fd96a61ba0a1dfbd7f24b921398affc357", 64 | "sha256:efa1909120ce98bbb3777e8b6f92237f5d5c8ea6758efea36a473e1d38f7d3e4", 65 | "sha256:f3900e8a5de27447acbf900b4750b0ddfd7ec1ea7fbaf11dfa911141bc522af0" 66 | ], 67 | "version": "==1.4.3" 68 | }, 69 | "mccabe": { 70 | "hashes": [ 71 | "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42", 72 | "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f" 73 | ], 74 | "version": "==0.6.1" 75 | }, 76 | "pylint": { 77 | "hashes": [ 78 | "sha256:bb4a908c9dadbc3aac18860550e870f58e1a02c9f2c204fdf5693d73be061210", 79 | "sha256:bfe68f020f8a0fece830a22dd4d5dddb4ecc6137db04face4c3420a46a52239f" 80 | ], 81 | "index": "pypi", 82 | "version": "==2.6.0" 83 | }, 84 | "six": { 85 | "hashes": [ 86 | "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", 87 | "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" 88 | ], 89 | "version": "==1.15.0" 90 | }, 91 | "toml": { 92 | "hashes": [ 93 | "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", 94 | "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f" 95 | ], 96 | "index": "pypi", 97 | "version": "==0.10.2" 98 | }, 99 | "wrapt": { 100 | "hashes": [ 101 | "sha256:b62ffa81fb85f4332a4f609cab4ac40709470da05643a082ec1eb88e6d9b97d7" 102 | ], 103 | "version": "==1.12.1" 104 | } 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # libreoffice-python-library 2 | Use python to manipulate the LibreOffice linux process. This framework can be used to create formatted text documents, pdfs, spreadsheets or drawings. 3 | 4 | ## Prerequisites 5 | - [python3.x](https://docs.python.org/3/using/unix.html) 6 | - [pipenv](https://github.com/pypa/pipenv) 7 | - [LibreOffice](https://gist.github.com/CosminEugenDinu/d584dddfce534f8272ab9f661eb480a5#file-install_libreoffice-sh) 8 | 9 | ## Install 10 | ```bash 11 | pipenv install -e "git+https://github.com/CosminEugenDinu/libreoffice-python-library.git#egg=libreoffice-py" 12 | ``` 13 | 14 | ## Setup 15 | - edit [***lo_config.toml***](https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/main/lo_config.toml) file to match your system configuration (if does not exists, it is created at first run) 16 | 17 | ## Usage 18 | ```py 19 | from libreoffice_py import document 20 | 21 | # Create a new spreadsheet (calc) document 22 | calc = document.Calc() 23 | sheets = calc.get_sheets() 24 | sheet_0 = sheets[0] 25 | cell_0 = sheet_0._uno_sheet.getCellByPosition(0,0) 26 | cell_0.setString('Hello World!') 27 | 28 | range = sheet_0.get_range(1, 1, 2, 2) 29 | data = [ 30 | ['Hello', 'World'], 31 | [0, 1] 32 | ] 33 | range.set_data(data) 34 | 35 | calc.save('./examples/saved/somefile.ods') 36 | calc.save('./examples/saved/somefile.jpg', 'jpg') 37 | calc.save('./examples/saved/somefile.pdf', 'pdf') 38 | calc.save('./examples/saved/somefile.png', 'png') 39 | calc.save('./examples/saved/somefile.xls', 'xls') 40 | calc.save('./examples/saved/somefile.xlsx', 'xlsx') 41 | 42 | # don't forget to kill the libreoffice process 43 | calc.desktop.terminate() 44 | ``` 45 | 46 | ## License 47 | ***libreoffice-python-library*** is distributed under GNU GPL V3. Because you will implicitely also use ***LibreOffice*** source code and binaries, its license Mozilla Public License v.2.0 applies as well. Copies of both are included in this repository. 48 | -------------------------------------------------------------------------------- /docs/UNO_Interprocess_Connections_DevelopersGuide_OOo3.1.0.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/docs/UNO_Interprocess_Connections_DevelopersGuide_OOo3.1.0.pdf -------------------------------------------------------------------------------- /docs/insp/helloworld.py: -------------------------------------------------------------------------------- 1 | import uno 2 | from os.path import isfile, join 3 | from os import getcwd 4 | from unohelper import systemPathToFileUrl, absolutize 5 | from com.sun.star.beans import PropertyValue 6 | 7 | 8 | outputfile = "helloworld.odt" 9 | url = "uno:socket,host=localhost,port=2002;urp;StarOffice.ComponentContext" 10 | ctxLocal = uno.getComponentContext() 11 | smgrLocal = ctxLocal.ServiceManager 12 | resolver = smgrLocal.createInstanceWithContext( 13 | "com.sun.star.bridge.UnoUrlResolver", ctxLocal ) 14 | ctx = resolver.resolve( url ) 15 | smgr = ctx.ServiceManager 16 | desktop = smgr.createInstanceWithContext("com.sun.star.frame.Desktop", ctx ) 17 | 18 | cwd = systemPathToFileUrl( getcwd() ) 19 | destFile = absolutize( cwd, systemPathToFileUrl(outputfile) ) 20 | inProps = PropertyValue( "Hidden" , 0 , True, 0 ), 21 | newdoc = desktop.loadComponentFromURL( 22 | "private:factory/swriter", "_blank", 0, inProps ) 23 | #get the XText interface 24 | text = newdoc.Text 25 | #create an XTextRange at the end of the document 26 | tRange = text.End 27 | #and set the string 28 | tRange.String = "Hello World (in Python)" 29 | print("Hello World (in Python)") 30 | newdoc.storeAsURL(destFile, ()) 31 | newdoc.dispose() 32 | print(f"File {outputfile} created.") 33 | 34 | # run this file with `python3 helloworld.py` 35 | # then close libreoffice-socket: kill PID 36 | -------------------------------------------------------------------------------- /docs/insp/soffice_connect.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | # first install libreoffice, like: 4 | # sudo apt-get install libreoffice --no-install-recommends 5 | 6 | # second start libreoffice --socket, like: 7 | # soffice_bin=/usr/lib/libreoffice/program/soffice.bin 8 | # $soffice_bin --headless --nologo --nofirststartwizard --norestore --nodefault --accept='socket,host=localhost,port=8100;urp;StarOffice.Service' 9 | 10 | # import uno system package; so far (11.12.2020)'uno' is not in 'pip' 11 | # to check if it's installed: 12 | # $ python3 13 | # >>> import uno 14 | # >>> dir(uno) 15 | # >>> print(uno.__file__) 16 | 17 | uno_package_location = '/usr/lib/python3/dist-packages/' 18 | sys.path.append(uno_package_location) 19 | import uno 20 | 21 | from os.path import isfile, join 22 | from os import getcwd 23 | from unohelper import systemPathToFileUrl, absolutize 24 | from com.sun.star.beans import PropertyValue 25 | 26 | 27 | outputfile = "helloworld.odt" 28 | url = "uno:socket,host=localhost,port=2002;urp;StarOffice.ComponentContext" 29 | ctxLocal = uno.getComponentContext() 30 | smgrLocal = ctxLocal.ServiceManager 31 | resolver = smgrLocal.createInstanceWithContext( 32 | "com.sun.star.bridge.UnoUrlResolver", ctxLocal ) 33 | ctx = resolver.resolve( url ) 34 | smgr = ctx.ServiceManager 35 | desktop = smgr.createInstanceWithContext("com.sun.star.frame.Desktop", ctx ) 36 | 37 | cwd = systemPathToFileUrl( getcwd() ) 38 | destFile = absolutize( cwd, systemPathToFileUrl(outputfile) ) 39 | inProps = PropertyValue( "Hidden" , 0 , True, 0 ), 40 | newdoc = desktop.loadComponentFromURL( 41 | "private:factory/swriter", "_blank", 0, inProps ) 42 | #get the XText interface 43 | text = newdoc.Text 44 | #create an XTextRange at the end of the document 45 | tRange = text.End 46 | #and set the string 47 | tRange.String = "Hello World (in Python)" 48 | print("Hello World (in Python)") 49 | newdoc.storeAsURL(destFile, ()) 50 | newdoc.dispose() 51 | print(f"File {outputfile} created.") 52 | 53 | # run this file with `python3 helloworld.py` 54 | # then close libreoffice-socket: kill PID -------------------------------------------------------------------------------- /docs/usefull-references.md: -------------------------------------------------------------------------------- 1 | 2 | ## LibreOffice (OpenOffice) UNO api: 3 | - https://wiki.openoffice.org/wiki/Documentation 4 | - [DevelopersGuide_OOo3.1.0.pdf](https://wiki.openoffice.org/w/images/d/d9/DevelopersGuide_OOo3.1.0.pdf) 5 | - https://wiki.openoffice.org/wiki/Python-Calc 6 | - https://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python 7 | - https://github.com/mirkonasato/pyodconverter 8 | - https://github.com/unoconv/unoconv 9 | - https://github.com/zbohm/python-ooolib 10 | - https://pypi.org/project/unotools/ 11 | - https://github.com/mila/pyoo 12 | - https://github.com/faide/py3o.template 13 | - https://github.com/T0ha/ezodf 14 | - https://github.com/robsco-git/spreadsheet_server 15 | 16 | -[filters used for save-as](https://github.com/LibreOffice/core/tree/330df37c7e2af0564bcd2de1f171bed4befcc074/filter/source/config/fragments/filters) 17 | -------------------------------------------------------------------------------- /examples/saved/somefile.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.jpg -------------------------------------------------------------------------------- /examples/saved/somefile.ods: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.ods -------------------------------------------------------------------------------- /examples/saved/somefile.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.pdf -------------------------------------------------------------------------------- /examples/saved/somefile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.png -------------------------------------------------------------------------------- /examples/saved/somefile.xls: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.xls -------------------------------------------------------------------------------- /examples/saved/somefile.xlsx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/examples/saved/somefile.xlsx -------------------------------------------------------------------------------- /libreoffice_py/__init__.py: -------------------------------------------------------------------------------- 1 | from . import config, document, libreoffice, libreoffice_process -------------------------------------------------------------------------------- /libreoffice_py/config.py: -------------------------------------------------------------------------------- 1 | import toml 2 | 3 | 4 | def _get_lo_config(): 5 | lo_config_default = """ 6 | 7 | [libreoffice] 8 | # To find this location, open python3 interactive, >>> import uno; print(uno.__file__) 9 | python_uno_location = "/usr/lib/python3/dist-packages/" 10 | 11 | # soffice.bin should be run with these flags 12 | flags = ["--headless", "--invisible", "--nocrashreport", "--nodefault", "--nofirststartwizard", "--nologo", "--norestore", "--accept='%s'"] 13 | 14 | [libreoffice.connection] 15 | binary_location = "/usr/lib/libreoffice/program/soffice.bin" 16 | 17 | # UNO socket connection settings 18 | host = "localhost" 19 | port = 2002 20 | 21 | # content of '--accept=' flag for starting soffice.bin with open connection 22 | accept_open = "socket,host=%s,port=%s,tcpNoDelay=1;urp;StarOffice.ComponentContext" 23 | 24 | # this is used to connect running libreoffice process with opened socket 25 | connection_url = "uno:socket,host=%s,port=%s,tcpNoDalay=1;urp;StarOffice.ComponentContext" 26 | 27 | # how much time to wait for connecting 28 | timeout = 5 29 | """ 30 | # load connection settings from Config toml file 31 | try: 32 | config = toml.load('./lo_config.toml') 33 | except FileNotFoundError as e: 34 | # creating default libreoffice config file 35 | print("Creating file ./lo_config.toml") 36 | with open('./lo_config.toml', 'w') as lo_config: 37 | lo_config.write(lo_config_default) 38 | 39 | return toml.loads(lo_config_default) 40 | 41 | 42 | 43 | config = _get_lo_config() -------------------------------------------------------------------------------- /libreoffice_py/document.py: -------------------------------------------------------------------------------- 1 | import os 2 | from .libreoffice import LibreOffice 3 | import uno 4 | 5 | 6 | 7 | class Calc: 8 | def __init__(self): 9 | libreoffice = LibreOffice() 10 | self.desktop = libreoffice.get_desktop() 11 | PropertyValue = uno.getClass('com.sun.star.beans.PropertyValue') 12 | inProps = PropertyValue( "Hidden" , 0 , True, 0 ), 13 | # https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/XComponentLoader.html 14 | self.document = self.desktop.loadComponentFromURL( 15 | "private:factory/scalc", "_blank", 0, inProps ) 16 | 17 | class Range: 18 | def __init__(self, _uno_range): 19 | self._uno_range = _uno_range 20 | 21 | def set_data(self, data): 22 | """ 23 | Fills the range cells with data (strings / numbers). 24 | Parameters 25 | data a tow dimensional array - must correspond with range dimensions 26 | """ 27 | return self._uno_range.setDataArray(data) 28 | 29 | class Sheet: 30 | def __init__(self, _uno_sheet): 31 | self._uno_sheet = _uno_sheet 32 | 33 | def get_range(self, nLeft, nTop, nRight, nBottom): 34 | """ 35 | Returns a sub-range of cells within the range. 36 | 37 | Parameters 38 | nLeft is the column index of the first cell inside the range. 39 | nTop is the row index of the first cell inside the range. 40 | nRight is the column index of the last cell inside the range. 41 | nBottom is the row index of the last cell inside the range. 42 | nSheet is the sheet index of the sheet inside the document. 43 | Returns 44 | the specified cell range. 45 | Exceptions 46 | com::sun::star::lang::IndexOutOfBoundsException if an index is outside the dimensions of this range. 47 | """ 48 | 49 | _uno_range = self._uno_sheet.getCellRangeByPosition(nLeft, nTop, nRight, nBottom) 50 | return Calc.Range(_uno_range) 51 | 52 | class Sheets: 53 | def __init__(self, document): 54 | self._uno_sheets = document.getSheets() 55 | 56 | def __getitem__(self, index): 57 | sheet = Calc.Sheet(self._uno_sheets[index]) 58 | return sheet 59 | 60 | def get_sheets(self): 61 | """ 62 | Returns the collection of sheets in the document. 63 | """ 64 | sheets = Calc.Sheets(self.document) 65 | return sheets 66 | 67 | def save(self, path, filetype=None): 68 | 69 | IOException = uno.getClass('com.sun.star.io.IOException') 70 | 71 | # UNO requires absolute paths 72 | url = uno.systemPathToFileUrl(os.path.abspath(path)) 73 | 74 | # Filters used when saving document. 75 | # https://github.com/LibreOffice/core/tree/330df37c7e2af0564bcd2de1f171bed4befcc074/filter/source/config/fragments/filters 76 | filetypes = dict( 77 | jpg='calc_jpg_Export', 78 | pdf='calc_pdf_Export', 79 | png='calc_png_Export', 80 | svg='calc_svg_Export', 81 | xls='Calc MS Excel 2007 XML', 82 | xlsx='Calc MS Excel 2007 XML Template', 83 | ) 84 | 85 | if filetype: 86 | filter = uno.createUnoStruct('com.sun.star.beans.PropertyValue') 87 | filter.Name = 'FilterName' 88 | filter.Value = filetypes[filetype] 89 | filters = (filter,) 90 | else: 91 | filters = () 92 | 93 | try: 94 | self.document.storeToURL(url, filters) 95 | except IOException as e: 96 | raise IOError(e.Message) 97 | 98 | class Draw: 99 | def __init__(self): 100 | pass 101 | 102 | class Writer: 103 | def __init__(self): 104 | pass 105 | def save(self): 106 | pass 107 | 108 | 109 | 110 | -------------------------------------------------------------------------------- /libreoffice_py/libreoffice.py: -------------------------------------------------------------------------------- 1 | from .libreoffice_process import LOprocess 2 | 3 | # from com.sun.star.beans import PropertyValue 4 | 5 | class LibreOffice: 6 | def __init__(self): 7 | self._lo_proc = LOprocess() 8 | self._uno_ctx = self._lo_proc.connect() 9 | self._uno_smgr = self._uno_ctx.ServiceManager 10 | self._desktop = self._uno_smgr.createInstanceWithContext( 11 | "com.sun.star.frame.Desktop", self._uno_ctx ) 12 | if not self._desktop: 13 | raise Exception("Failed to create LibreOffice desktop") 14 | 15 | def get_desktop(self): 16 | return self._desktop 17 | 18 | def terminate(self, desktop): 19 | self._lo_proc.terminate(desktop) 20 | 21 | 22 | -------------------------------------------------------------------------------- /libreoffice_py/libreoffice_process.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import time 3 | import subprocess 4 | from .config import config 5 | # uno.py directory (package) path 6 | sys.path.append(config['libreoffice']['python_uno_location']) 7 | # ***** UNO ***** 8 | import uno 9 | NoConnectException = uno.getClass('com.sun.star.connection.NoConnectException') 10 | # from com.sun.star.connection import NoConnectException 11 | 12 | now = time.time 13 | 14 | 15 | class LOprocess: 16 | def __init__(self, 17 | connection=config['libreoffice']['connection']): 18 | 19 | # command flags array 20 | self.flags = config['libreoffice']['flags'] 21 | 22 | # libreoffice binary location 23 | self.libreoffice_bin = connection['binary_location'] 24 | # # UNO socket connection settings 25 | self.host = connection['host'] 26 | self.port = connection['port'] 27 | # will become content of '--accept=' flag, like f"--accept='{accept_open}'" 28 | # something like "socket,host=%s,port=%s,tcpNoDelay=1;urp;StarOffice.ComponentContext" 29 | self.accept_open = connection['accept_open'] 30 | # this is used when connetion to running libreoffice process 31 | # something like "uno:socket,host=%s,port=%s,tcpNoDalay=1;urp;StarOffice.ComponentContext" 32 | self.connection_url = connection['connection_url'] 33 | self.timeout = connection['timeout'] 34 | 35 | # process ref of running libreoffice set from startup method 36 | self.loproc = None 37 | self.desktop = None 38 | 39 | def startup(self, port=None): 40 | """ Starts libreoffice process. 41 | """ 42 | 43 | accept_open = self.accept_open % (self.host, (port or self.port)) 44 | # "--accept=%s" => %s is replaced with accept_open 45 | # stringify command flags 46 | start_command_flags = ' '.join(self.flags) % accept_open 47 | 48 | # command used to start libreoffice with open socket 49 | start_command = f"{self.libreoffice_bin} {start_command_flags}" 50 | 51 | # if named pipe connection: 52 | # "--accept='pipe,name=somepipename;urp;StarOffice.ComponentContext'" 53 | 54 | lo_proc = subprocess.Popen(start_command, shell=True) 55 | 56 | # I could'n connect to process if opended it like this: 57 | # lo_proc = subprocess.Popen(start_command.split()) 58 | 59 | return lo_proc 60 | 61 | def connect(self, host=None, port=None): 62 | 63 | local_ctx = uno.getComponentContext() 64 | smgr_local = local_ctx.ServiceManager 65 | resolver = smgr_local.createInstanceWithContext( 66 | "com.sun.star.bridge.UnoUrlResolver", local_ctx) 67 | url = self.connection_url % (self.host, (port or self.port)) 68 | 69 | uno_ctx = None 70 | # try to resolve connection 71 | try: 72 | # url = "uno:socket,host=localhost,port=2002,tcpNoDalay=1;urp;StarOffice.ComponentContext" 73 | # url = "uno:pipe,name=somepipename;urp;StarOffice.ComponentContext" 74 | uno_ctx = resolver.resolve(url) 75 | except NoConnectException as nce: 76 | # launch libreoffice process 77 | lo_proc = self.startup() 78 | 79 | timeout = 0 80 | while timeout < self.timeout: 81 | # Is it already/still running? 82 | retcode = lo_proc.poll() 83 | if retcode == 81: 84 | # self.connect() 85 | continue 86 | # elif retcode is not None: 87 | # raise 88 | try: 89 | uno_ctx = resolver.resolve(url) 90 | break 91 | except NoConnectException: 92 | time.sleep(0.5) 93 | timeout += 0.5 94 | 95 | return uno_ctx 96 | 97 | def terminate(self, desktop): 98 | desktop.terminate() 99 | 100 | -------------------------------------------------------------------------------- /libreoffice_py/utils.py: -------------------------------------------------------------------------------- 1 | """ 2 | libreoffice_py.utils 3 | 4 | This module provides utility functions. 5 | """ 6 | 7 | -------------------------------------------------------------------------------- /lo_config.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | [libreoffice] 4 | # To find this location, open python3 interactive, >>> import uno; print(uno.__file__) 5 | python_uno_location = "/usr/lib/python3/dist-packages/" 6 | 7 | # soffice.bin should be run with these flags 8 | flags = ["--headless", "--invisible", "--nocrashreport", "--nodefault", "--nofirststartwizard", "--nologo", "--norestore", "--accept='%s'"] 9 | 10 | [libreoffice.connection] 11 | binary_location = "/usr/lib/libreoffice/program/soffice.bin" 12 | 13 | # UNO socket connection settings 14 | host = "localhost" 15 | port = 2002 16 | 17 | # content of '--accept=' flag for starting soffice.bin with open connection 18 | accept_open = "socket,host=%s,port=%s,tcpNoDelay=1;urp;StarOffice.ComponentContext" 19 | 20 | # this is used to connect running libreoffice process with opened socket 21 | connection_url = "uno:socket,host=%s,port=%s,tcpNoDalay=1;urp;StarOffice.ComponentContext" 22 | 23 | # how much time to wait for connecting 24 | timeout = 5 25 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | with open("README.md", "r") as fh: 4 | long_description = fh.read() 5 | 6 | setuptools.setup( 7 | name="libreoffice-py", 8 | version="0.0.1", 9 | author="Cosmin Eugen Dinu", 10 | author_email="tcosdev@gmail.com", 11 | description="Python-UNO-LibreOffice interface for working with documents.", 12 | long_description=long_description, 13 | long_description_content_type="text/markdown", 14 | url="https://github.com/CosminEugenDinu/libreoffice-python-library/tree/pypi", 15 | packages=setuptools.find_packages(), 16 | install_requires=['toml'], 17 | classifiers=[ 18 | "Programming Language :: Python :: 3", 19 | "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", 20 | "Operating System :: OS Independent", 21 | ], 22 | python_requires='>=3.6', 23 | ) -------------------------------------------------------------------------------- /test/test.py: -------------------------------------------------------------------------------- 1 | # testing 2 | import sys 3 | sys.path.append('.') 4 | from libreoffice_py import document 5 | 6 | calc = document.Calc() 7 | sheet = calc.get_sheets()[0] 8 | range = sheet.get_range(0, 0, 1, 1) 9 | data = [ 10 | ['Hello', 'World'], 11 | [0, 1] 12 | ] 13 | range.set_data(data) 14 | calc.save('./test/testfile.ods') 15 | calc.desktop.terminate() 16 | 17 | -------------------------------------------------------------------------------- /test/test_save_pdf.py: -------------------------------------------------------------------------------- 1 | # testing 2 | import sys 3 | sys.path.append('.') 4 | from libreoffice_py import document 5 | from calendar import Calendar 6 | from datetime import date 7 | 8 | today = date.today() 9 | 10 | calc = document.Calc() 11 | sheet = calc.get_sheets()[0] 12 | 13 | month = 4 14 | cal = Calendar(firstweekday=0) 15 | monthdates = [ 16 | f'{d[0]}.{d[1]}.{d[2]}' for d in cal.itermonthdays4(today.year, month) 17 | if d[3] not in (5,6) and d[1] == month 18 | ] 19 | 20 | data = [ 21 | ['Firm', 'BRIGHT', '', '', ''], 22 | ['Address', 'Street no.', '', '', ''], 23 | ['Employee', 'Jack Sprot', '', '', ''], 24 | ['Date', 'Arrive at', 'Sign at arrival', 'Leave at', 'Sign at arrival'] 25 | ] 26 | 27 | for d in monthdates: 28 | data.append([d, '', '08:00', '', '18:00']) 29 | 30 | for line in data: 31 | print(line) 32 | range = sheet.get_range(0, 0, len(data[0])-1, len(data)-1) 33 | 34 | range.set_data(data) 35 | calc.save('./test/testfile.pdf', 'pdf') 36 | calc.desktop.terminate() -------------------------------------------------------------------------------- /test/testfile.ods: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/test/testfile.ods -------------------------------------------------------------------------------- /test/testfile.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CosminEugenDinu/libreoffice-python-library/334f0661602372014a6e6281ba57bdbbda497111/test/testfile.pdf --------------------------------------------------------------------------------