pyminizip


Namepyminizip JSON
Version 0.2.6 PyPI version JSON
download
home_pagehttps://github.com/smihica/pyminizip
SummaryA minizip wrapper - To create a password encrypted zip file in python.
upload_time2021-12-21 02:12:19
maintainer
docs_urlNone
authorShin Aoyama
requires_python
license
keywords zip file compress password encryption
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## pyminizip

To create a password encrypted zip file in python.
And the zip file is able to extract in WINDOWS.

This is a simple Minizip wrapper of python.
(http://www.winimage.com/zLibDll/minizip.html)

This software uses zlib.
License: zlib/libpng License.

## Install
```
$ pip install pyminizip
```

## Install zlib
```
# linux
$ sudo apt-get install zlib
# mac
$ xcode-select --install
$ brew install zlib
```

## How to use

This package just provides three functions.

```
pyminizip.compress("/srcfile/path.txt", "file_path_prefix", "/distfile/path.zip", "password", int(compress_level))
```

  Args:
  1. src file path (string)
  2. src file prefix path (string) or None (path to prepend to file)
  3. dst file path (string)
  4. password (string) or None (to create no-password zip)
  5. compress_level(int) between 1 to 9, 1 (more fast) <---> 9 (more compress) or 0 (default)

  Return value:
  - always returns None

```
pyminizip.compress_multiple([u'pyminizip.so', 'file2.txt'], [u'/path_for_file1', u'/path_for_file2'], "file.zip", "1233", 4, progress)
```

  Args:
  1. src file LIST path (list)
  2. src file LIST prefix path (list) or []
  3. dst file path (string)
  4. password (string) or None (to create no-password zip)
  5. compress_level(int) between 1 to 9, 1 (more fast)  <---> 9 (more compress)
  6. optional function to be called during processing which takes one argument, the count of how many files have been compressed

  Return value:
  - always returns None

```
pyminizip.uncompress("/srcfile/path.zip", "password", "/dirtoextract", int(withoutpath))
```

  Args:
  1. src file path (string)
  2. password (string) or None (to unzip encrypted archives)
  3. dir path to extract files or None (to extract in a specific dir or cwd)
  4. withoutpath (exclude path of extracted)

  Return value:
  - always returns None



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/smihica/pyminizip",
    "name": "pyminizip",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "zip,file,compress,password,encryption",
    "author": "Shin Aoyama",
    "author_email": "smihica@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1b/b4/b5584325a03acfbca05922700ab9195b5875a936dc23960224087088a409/pyminizip-0.2.6.tar.gz",
    "platform": "",
    "description": "## pyminizip\n\nTo create a password encrypted zip file in python.\nAnd the zip file is able to extract in WINDOWS.\n\nThis is a simple Minizip wrapper of python.\n(http://www.winimage.com/zLibDll/minizip.html)\n\nThis software uses zlib.\nLicense: zlib/libpng License.\n\n## Install\n```\n$ pip install pyminizip\n```\n\n## Install zlib\n```\n# linux\n$ sudo apt-get install zlib\n# mac\n$ xcode-select --install\n$ brew install zlib\n```\n\n## How to use\n\nThis package just provides three functions.\n\n```\npyminizip.compress(\"/srcfile/path.txt\", \"file_path_prefix\", \"/distfile/path.zip\", \"password\", int(compress_level))\n```\n\n  Args:\n  1. src file path (string)\n  2. src file prefix path (string) or None (path to prepend to file)\n  3. dst file path (string)\n  4. password (string) or None (to create no-password zip)\n  5. compress_level(int) between 1 to 9, 1 (more fast) <---> 9 (more compress) or 0 (default)\n\n  Return value:\n  - always returns None\n\n```\npyminizip.compress_multiple([u'pyminizip.so', 'file2.txt'], [u'/path_for_file1', u'/path_for_file2'], \"file.zip\", \"1233\", 4, progress)\n```\n\n  Args:\n  1. src file LIST path (list)\n  2. src file LIST prefix path (list) or []\n  3. dst file path (string)\n  4. password (string) or None (to create no-password zip)\n  5. compress_level(int) between 1 to 9, 1 (more fast)  <---> 9 (more compress)\n  6. optional function to be called during processing which takes one argument, the count of how many files have been compressed\n\n  Return value:\n  - always returns None\n\n```\npyminizip.uncompress(\"/srcfile/path.zip\", \"password\", \"/dirtoextract\", int(withoutpath))\n```\n\n  Args:\n  1. src file path (string)\n  2. password (string) or None (to unzip encrypted archives)\n  3. dir path to extract files or None (to extract in a specific dir or cwd)\n  4. withoutpath (exclude path of extracted)\n\n  Return value:\n  - always returns None\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A minizip wrapper - To create a password encrypted zip file in python.",
    "version": "0.2.6",
    "project_urls": {
        "Homepage": "https://github.com/smihica/pyminizip"
    },
    "split_keywords": [
        "zip",
        "file",
        "compress",
        "password",
        "encryption"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1bb4b5584325a03acfbca05922700ab9195b5875a936dc23960224087088a409",
                "md5": "2edbc128fba26eff690d4be275512bed",
                "sha256": "0a954dd2a65fd72c8b827b83fb806fb4f301075a6ec43e207d3345ab15843a7a"
            },
            "downloads": -1,
            "filename": "pyminizip-0.2.6.tar.gz",
            "has_sig": false,
            "md5_digest": "2edbc128fba26eff690d4be275512bed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 261210,
            "upload_time": "2021-12-21T02:12:19",
            "upload_time_iso_8601": "2021-12-21T02:12:19.134331Z",
            "url": "https://files.pythonhosted.org/packages/1b/b4/b5584325a03acfbca05922700ab9195b5875a936dc23960224087088a409/pyminizip-0.2.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-12-21 02:12:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "smihica",
    "github_project": "pyminizip",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pyminizip"
}
        
Elapsed time: 0.15259s