zipd


Namezipd JSON
Version 0.3.10 PyPI version JSON
download
home_pageNone
SummaryRecursively zip up a directory/folder
upload_time2024-11-17 03:11:51
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 jmknoble 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 cli git gitignore recursive zip
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # zipd

[![EditorConfig-enabled](https://img.shields.io/badge/EditorConfig-enabled-brightgreen?logo=EditorConfig&logoColor=white)](https://editorconfig.org/)
[![pre-commit-enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com)
[![Python-3.10+](https://img.shields.io/badge/Python-3.10+-informational?logo=Python&logoColor=white)](https://www.python.org)
[![CodeStyle-ruff](https://img.shields.io/badge/CodeStyle-black-informational)](https://astral.sh/ruff)


Convenience utility for recursively zipping up a directory (or "folder").
Formerly known as `zipdir`.


[begintoc]: #

## Contents

- [Features](#features)
- [Requirements](#requirements)
- [Installing](#installing)
- [References](#references)

[endtoc]: # (Generated by mark-toc pre-commit hook)


## Features

- Can filter some revision control files out of resulting zipfile.
- Can use [.gitignore][] file for filtering.
- Can zip up a [git][] workspace including the `.git` folder.
- Can make a fresh zipfile or reuse an existing one.
- Can pass options to **zip**.
- Dry run.


## Requirements

- A [Python](https://www.python.org/) interpreter, version 3.10 or later
- [zip][] installed somewhere on your path


## Installing

It is recommended to install **zipd** in its own virtual environment (for example, using [uv][]).

Once you have [uv installed][uv-install], you can use it to install `zipd` as follows:

    uv tool install zipd

Then:

    uv tool run zipd --help

or:

    uvx zipd --help


## References

- [zip][]
- [git][] ([.gitignore][])
- [gitignore-parser][]
- [uv][] ([install][uv-install])


 [git]: https://git-scm.com/
 [.gitignore]: https://git-scm.com/docs/gitignore
 [gitignore-parser]: https://github.com/mherrmann/gitignore_parser
 [python]: https://www.python.org/
 [uv]: https://github.com/astral-sh/uv
 [uv-install]: https://docs.astral.sh/uv/getting-started/installation
 [zip]: https://infozip.sourceforge.net/Zip.html

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "zipd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "cli, git, gitignore, recursive, zip",
    "author": null,
    "author_email": "jmknoble <jmknoble@pobox.com>",
    "download_url": "https://files.pythonhosted.org/packages/cd/02/e6347431925fb01d441bdbd480a6a8524eb3ade0b3969452bbb8d5e89420/zipd-0.3.10.tar.gz",
    "platform": null,
    "description": "# zipd\n\n[![EditorConfig-enabled](https://img.shields.io/badge/EditorConfig-enabled-brightgreen?logo=EditorConfig&logoColor=white)](https://editorconfig.org/)\n[![pre-commit-enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com)\n[![Python-3.10+](https://img.shields.io/badge/Python-3.10+-informational?logo=Python&logoColor=white)](https://www.python.org)\n[![CodeStyle-ruff](https://img.shields.io/badge/CodeStyle-black-informational)](https://astral.sh/ruff)\n\n\nConvenience utility for recursively zipping up a directory (or \"folder\").\nFormerly known as `zipdir`.\n\n\n[begintoc]: #\n\n## Contents\n\n- [Features](#features)\n- [Requirements](#requirements)\n- [Installing](#installing)\n- [References](#references)\n\n[endtoc]: # (Generated by mark-toc pre-commit hook)\n\n\n## Features\n\n- Can filter some revision control files out of resulting zipfile.\n- Can use [.gitignore][] file for filtering.\n- Can zip up a [git][] workspace including the `.git` folder.\n- Can make a fresh zipfile or reuse an existing one.\n- Can pass options to **zip**.\n- Dry run.\n\n\n## Requirements\n\n- A [Python](https://www.python.org/) interpreter, version 3.10 or later\n- [zip][] installed somewhere on your path\n\n\n## Installing\n\nIt is recommended to install **zipd** in its own virtual environment (for example, using [uv][]).\n\nOnce you have [uv installed][uv-install], you can use it to install `zipd` as follows:\n\n    uv tool install zipd\n\nThen:\n\n    uv tool run zipd --help\n\nor:\n\n    uvx zipd --help\n\n\n## References\n\n- [zip][]\n- [git][] ([.gitignore][])\n- [gitignore-parser][]\n- [uv][] ([install][uv-install])\n\n\n [git]: https://git-scm.com/\n [.gitignore]: https://git-scm.com/docs/gitignore\n [gitignore-parser]: https://github.com/mherrmann/gitignore_parser\n [python]: https://www.python.org/\n [uv]: https://github.com/astral-sh/uv\n [uv-install]: https://docs.astral.sh/uv/getting-started/installation\n [zip]: https://infozip.sourceforge.net/Zip.html\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 jmknoble  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": "Recursively zip up a directory/folder",
    "version": "0.3.10",
    "project_urls": {
        "Repository": "https://github.com/jmknoble/zipd"
    },
    "split_keywords": [
        "cli",
        " git",
        " gitignore",
        " recursive",
        " zip"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b1e3127411648f2f8de84e3d6e2c8e94a2020ab0f8e4f3df38f71611aff7971",
                "md5": "3e26bd8a02bd0a4281e2fc9b563768c7",
                "sha256": "a9586bed99311d3f3a295e8599976f1a516d006b3b1c5a5169e80dc57ba21625"
            },
            "downloads": -1,
            "filename": "zipd-0.3.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3e26bd8a02bd0a4281e2fc9b563768c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10025,
            "upload_time": "2024-11-17T03:11:50",
            "upload_time_iso_8601": "2024-11-17T03:11:50.266244Z",
            "url": "https://files.pythonhosted.org/packages/9b/1e/3127411648f2f8de84e3d6e2c8e94a2020ab0f8e4f3df38f71611aff7971/zipd-0.3.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd02e6347431925fb01d441bdbd480a6a8524eb3ade0b3969452bbb8d5e89420",
                "md5": "d7d6682267cceafc2756c1a3ac793cea",
                "sha256": "cb7197c7d2991c6b0529362b72223aa4caa50e148d441d4d6fceb4650f66c171"
            },
            "downloads": -1,
            "filename": "zipd-0.3.10.tar.gz",
            "has_sig": false,
            "md5_digest": "d7d6682267cceafc2756c1a3ac793cea",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 29664,
            "upload_time": "2024-11-17T03:11:51",
            "upload_time_iso_8601": "2024-11-17T03:11:51.579815Z",
            "url": "https://files.pythonhosted.org/packages/cd/02/e6347431925fb01d441bdbd480a6a8524eb3ade0b3969452bbb8d5e89420/zipd-0.3.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-17 03:11:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jmknoble",
    "github_project": "zipd",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "zipd"
}
        
Elapsed time: 1.45370s