Skip to main content

On-the-fly zip of streamed file with optional zipcrypto.

Project description

Ziphyr

Ziphyr is an on-the-fly zip archiving applied on a streamed file source, with optional on-the-fly encryption.

GitHub GitHub Workflow Status (branch) PyPI PyPI - Python Version

Features

  • Disclaimer: the zip-native cryptography is unsecure
  • Streamed file turned into a streamed zip
  • Can be used password-less for a non-encrypted zip stream
  • Or with a password to apply on-the-fly zipcrypto to the stream
  • Retro-compatibility for py35 with writable ZipInfo port

Install

    $ pip install ziphyr

Usage

   from ziphyr import Ziphyr

   # init the Ziphyr object
   z = Ziphyr(b'infected')
   # z = Ziphyr() for crypto-less usage

   # prepare it for a specific file, from path or metadata directly
   z.from_filepath(filepath)

   # consume the generator to get the encrypted ziped chunk
   for k in z.generator(source):
       pass

Test

   $ python -m unittest -v tests/*.py

Contributing

Contributions are welcome and are always greatly appreciated. Every little bit helps and credit will always be given. You can contribute in many ways:

  • reporting a bug
  • submitting feedback
  • helping fix bugs
  • implementing new features
  • writting better documentation

Remember that before submitting a pull request, you should if relevant include tests and update documentation.

Credits and references

zip-related

Underlying works

The following works served as sources of inspiration or examples for implementation.

Cookiecutter

This package was kickstarted with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ziphyr-0.2.0.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

ziphyr-0.2.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file ziphyr-0.2.0.tar.gz.

File metadata

  • Download URL: ziphyr-0.2.0.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.0

File hashes

Hashes for ziphyr-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0195ad3ae18c717a12c9fd447eb31e95368524fb148943f94a68e086b9f8cee8
MD5 465596db269eaa9ecf107041accae34f
BLAKE2b-256 938d204597d28f15990c6961126b7a8dcd8a6ef8e8876febf2e0e879bb625161

See more details on using hashes here.

File details

Details for the file ziphyr-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ziphyr-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.0

File hashes

Hashes for ziphyr-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45ce49e376f0c6f8c2218d9f17d45c3600dcf8fb4537a4e399f07d692e4af280
MD5 afbf72478a93c834e2ac953ca5d4dd27
BLAKE2b-256 8e68ac7bb71e7c62a539c328cae389e4c56d719e47136bfdcf90a994337291bf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page