docx-locker


Namedocx-locker JSON
Version 0.7.1 PyPI version JSON
download
home_pageNone
SummaryPython module for enabling document protection on docx files
upload_time2024-09-16 11:59:43
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2024 RH1 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 documentprotection
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![image](https://img.shields.io/pypi/v/docx-locker)](https://pypi.org/project/docx-locker/)
[![image](https://img.shields.io/pypi/l/docx-locker)](https://github.com/rowanhoy/docx-locker/blob/main/LICENSE)
[![image](https://img.shields.io/pypi/pyversions/docx-locker)](https://pypi.org/project/docx-locker/)
[![CodeQL](https://github.com/rowanhoy/docx-locker/actions/workflows/codeql.yml/badge.svg?branch=main&event=push)](https://github.com/rowanhoy/docx-locker/actions/workflows/codeql.yml)
[![codecov](https://codecov.io/github/rowanhoy/docx-locker/graph/badge.svg?token=FW6CBDRBV4)](https://codecov.io/github/rowanhoy/docx-locker)
[![GitHub Actions](https://github.com/rowanhoy/docx-locker/workflows/Release/badge.svg)](https://github.com/rowanhoy/docx-locker/actions)
[![GitHub Actions](https://github.com/rowanhoy/docx-locker/workflows/Tests/badge.svg)](https://github.com/rowanhoy/docx-locker/actions)


# docx-locker
Simple python module with a single dependency for getting and setting document protection on docx files.

## Compatibility

The module has been tested against documents generated by word 2016 and higher, and should be compatible with other modules that generate standard docx files.

## Install

```sh
pip install docx_locker
```

## Usage
```python
from docx_locker import apply_docx_protection

docx_path = 'full/file/path.docx'
apply_docx_protection(docx_path, 'password')

```

Check the [docs](https://rowanhoy.github.io/docx-locker) for a full list of supported args.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "docx-locker",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "docx, documentProtection",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/03/af/557479e32d617e8f944bf3fe8bed2f37d29a7cf35c36db0d58285f38b72d/docx_locker-0.7.1.tar.gz",
    "platform": null,
    "description": "[![image](https://img.shields.io/pypi/v/docx-locker)](https://pypi.org/project/docx-locker/)\n[![image](https://img.shields.io/pypi/l/docx-locker)](https://github.com/rowanhoy/docx-locker/blob/main/LICENSE)\n[![image](https://img.shields.io/pypi/pyversions/docx-locker)](https://pypi.org/project/docx-locker/)\n[![CodeQL](https://github.com/rowanhoy/docx-locker/actions/workflows/codeql.yml/badge.svg?branch=main&event=push)](https://github.com/rowanhoy/docx-locker/actions/workflows/codeql.yml)\n[![codecov](https://codecov.io/github/rowanhoy/docx-locker/graph/badge.svg?token=FW6CBDRBV4)](https://codecov.io/github/rowanhoy/docx-locker)\n[![GitHub Actions](https://github.com/rowanhoy/docx-locker/workflows/Release/badge.svg)](https://github.com/rowanhoy/docx-locker/actions)\n[![GitHub Actions](https://github.com/rowanhoy/docx-locker/workflows/Tests/badge.svg)](https://github.com/rowanhoy/docx-locker/actions)\n\n\n# docx-locker\nSimple python module with a single dependency for getting and setting document protection on docx files.\n\n## Compatibility\n\nThe module has been tested against documents generated by word 2016 and higher, and should be compatible with other modules that generate standard docx files.\n\n## Install\n\n```sh\npip install docx_locker\n```\n\n## Usage\n```python\nfrom docx_locker import apply_docx_protection\n\ndocx_path = 'full/file/path.docx'\napply_docx_protection(docx_path, 'password')\n\n```\n\nCheck the [docs](https://rowanhoy.github.io/docx-locker) for a full list of supported args.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 RH1  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": "Python module for enabling document protection on docx files",
    "version": "0.7.1",
    "project_urls": null,
    "split_keywords": [
        "docx",
        " documentprotection"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "46ec3b91ebc92ed721e23fb21dfff0e91e13c24b1bfc0ca419e703e485209254",
                "md5": "9f9dd455ecbe7818b354f34f9770928b",
                "sha256": "af491432b38ec81006360a89b93232e47c101954773822e47160886319f22ad8"
            },
            "downloads": -1,
            "filename": "docx_locker-0.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9f9dd455ecbe7818b354f34f9770928b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7902,
            "upload_time": "2024-09-16T11:59:41",
            "upload_time_iso_8601": "2024-09-16T11:59:41.757344Z",
            "url": "https://files.pythonhosted.org/packages/46/ec/3b91ebc92ed721e23fb21dfff0e91e13c24b1bfc0ca419e703e485209254/docx_locker-0.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "03af557479e32d617e8f944bf3fe8bed2f37d29a7cf35c36db0d58285f38b72d",
                "md5": "f87e093a5b01d41b4f225b29b6ab7bfa",
                "sha256": "f417bca7fc939c6106616893e8ad49363f934d308154cc9d62186e6a3049f56b"
            },
            "downloads": -1,
            "filename": "docx_locker-0.7.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f87e093a5b01d41b4f225b29b6ab7bfa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 9982,
            "upload_time": "2024-09-16T11:59:43",
            "upload_time_iso_8601": "2024-09-16T11:59:43.210742Z",
            "url": "https://files.pythonhosted.org/packages/03/af/557479e32d617e8f944bf3fe8bed2f37d29a7cf35c36db0d58285f38b72d/docx_locker-0.7.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-16 11:59:43",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "docx-locker"
}
        
Elapsed time: 0.30468s