Giter VIP home page Giter VIP logo

ziphyr's Introduction

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.

ziphyr's People

Contributors

guzmud avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.