bayoo-docx


Namebayoo-docx JSON
Version 0.2.20 PyPI version JSON
download
home_pagehttps://github.com/BayooG/bayooo-docx
SummaryCreate and update Microsoft Word .docx files.
upload_time2023-02-25 22:07:25
maintainer
docs_urlNone
authorObay Daba
requires_python
licenseThe MIT License (MIT) Copyright (c) 2019 Obay Daba, https://github.com/bayoog forked from https://github.com/python-openxml/python-docx Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords docx office openxml word
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            Bayoo-docx


Python library forked from  `python-docx <github.com/python-openxml/python-docx/>`_.

The main purpose of the fork was to add implementation for comments and footnotes to the library

Installation


Use the package manager `pip <pypi.org/project/bayoo-docx/>`_ to install bayoo-docx.


`pip install bayoo-docx`

Usage


::
    
    import docx
    
    document = docx.Document()

    paragraph1 = document.add_paragraph('text') # create new paragraph

    comment = paragraph.add_comment('comment',author='Obay Daba',initials= 'od') # add a comment on the entire paragraph

    paragraph2 = document.add_paragraph('text') # create another paragraph

    run = paragraph2.add_run('texty') add a run to the paragraph

    run.add_comment('comment') # add a comment only for the run text 

    paragraph.add_footnote('footnote text') # add a footnote



License


`MIT <https://choosealicense.com/licenses/mit/>`_


.. :changelog:


#Release History BayooG/bayoo-docx forked from (python-openxmm/python-docx)


0.2.8 (2020-05-02)

- add comments implementation on a run level
- fix issue with comments date (comments dates are set to current date)


0.2.4 (2019-9-4)

- loop over all the document chieldern (Paragraphs, Tables, Sections) with the right order `document.elements`
- addons to Paragraph Object (delete, heading_level, merge_paragraph )
- Add low-level implementation for comments part
- Add oxml element for <w:comments> element and sub-elements
- Add add_comment() method for docx.text.Paragraph 
- Add low-level implementation for footnotes part
- Add oxml element for <w:footnotes> element and sub-elements
- Add add_footnote() method for docx.text.Paragraph 



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BayooG/bayooo-docx",
    "name": "bayoo-docx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "docx office openxml word",
    "author": "Obay Daba",
    "author_email": "ObayDaba96@googlegroups.com",
    "download_url": "https://files.pythonhosted.org/packages/4e/ea/297732e5b94d29254434fb210b4a58b759e7145a872983d011dd4d0e9803/bayoo-docx-0.2.20.tar.gz",
    "platform": null,
    "description": "Bayoo-docx\n\n\nPython library forked from  `python-docx <github.com/python-openxml/python-docx/>`_.\n\nThe main purpose of the fork was to add implementation for comments and footnotes to the library\n\nInstallation\n\n\nUse the package manager `pip <pypi.org/project/bayoo-docx/>`_ to install bayoo-docx.\n\n\n`pip install bayoo-docx`\n\nUsage\n\n\n::\n    \n    import docx\n    \n    document = docx.Document()\n\n    paragraph1 = document.add_paragraph('text') # create new paragraph\n\n    comment = paragraph.add_comment('comment',author='Obay Daba',initials= 'od') # add a comment on the entire paragraph\n\n    paragraph2 = document.add_paragraph('text') # create another paragraph\n\n    run = paragraph2.add_run('texty') add a run to the paragraph\n\n    run.add_comment('comment') # add a comment only for the run text \n\n    paragraph.add_footnote('footnote text') # add a footnote\n\n\n\nLicense\n\n\n`MIT <https://choosealicense.com/licenses/mit/>`_\n\n\n.. :changelog:\n\n\n#Release History BayooG/bayoo-docx forked from (python-openxmm/python-docx)\n\n\n0.2.8 (2020-05-02)\n\n- add comments implementation on a run level\n- fix issue with comments date (comments dates are set to current date)\n\n\n0.2.4 (2019-9-4)\n\n- loop over all the document chieldern (Paragraphs, Tables, Sections) with the right order `document.elements`\n- addons to Paragraph Object (delete, heading_level, merge_paragraph )\n- Add low-level implementation for comments part\n- Add oxml element for <w:comments> element and sub-elements\n- Add add_comment() method for docx.text.Paragraph \n- Add low-level implementation for footnotes part\n- Add oxml element for <w:footnotes> element and sub-elements\n- Add add_footnote() method for docx.text.Paragraph \n\n\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT) Copyright (c) 2019 Obay Daba, https://github.com/bayoog forked from https://github.com/python-openxml/python-docx  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Create and update Microsoft Word .docx files.",
    "version": "0.2.20",
    "project_urls": {
        "Homepage": "https://github.com/BayooG/bayooo-docx"
    },
    "split_keywords": [
        "docx",
        "office",
        "openxml",
        "word"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c99ff281e9e33c5ca7905948df92ac378b41339ee36972290c85497833926f3b",
                "md5": "aad9f26b3f00763f32e4b8c0b6cacd22",
                "sha256": "799ebe491f715bcbaa437a0d4b2aabc82315f3da97a151d2dff126c08a24acda"
            },
            "downloads": -1,
            "filename": "bayoo_docx-0.2.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aad9f26b3f00763f32e4b8c0b6cacd22",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 193135,
            "upload_time": "2023-02-25T22:07:23",
            "upload_time_iso_8601": "2023-02-25T22:07:23.002193Z",
            "url": "https://files.pythonhosted.org/packages/c9/9f/f281e9e33c5ca7905948df92ac378b41339ee36972290c85497833926f3b/bayoo_docx-0.2.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4eea297732e5b94d29254434fb210b4a58b759e7145a872983d011dd4d0e9803",
                "md5": "c25c07fbdd0a41e34adfc25c7bdc4b94",
                "sha256": "f9635728a625fbfdd998885eca3d321b54b9114aaf7cc45c7f59ef0df9a1bd10"
            },
            "downloads": -1,
            "filename": "bayoo-docx-0.2.20.tar.gz",
            "has_sig": false,
            "md5_digest": "c25c07fbdd0a41e34adfc25c7bdc4b94",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5512029,
            "upload_time": "2023-02-25T22:07:25",
            "upload_time_iso_8601": "2023-02-25T22:07:25.085088Z",
            "url": "https://files.pythonhosted.org/packages/4e/ea/297732e5b94d29254434fb210b4a58b759e7145a872983d011dd4d0e9803/bayoo-docx-0.2.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-25 22:07:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BayooG",
    "github_project": "bayooo-docx",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "bayoo-docx"
}
        
Elapsed time: 0.30833s