Skip to content

Democritus functions for working with archives.

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING
Notifications You must be signed in to change notification settings

democritus-project/d8s-archives

Repository files navigation

Democritus Archives (a.k.a. d8s-archives)

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with archives.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-archives

Usage

You import the library like:

from d8s_archives import *

Once imported, you can use any of the functions listed below.

Functions

  • def archive_create(file_path, output_path, *, archive_name=None):
        """Archive the given file."""
  • def archive_read(file_path, *, archive_name=None, password=None) -> Iterable[Tuple[str, str]]:
        """Read file(s) from the archive. If archive_name is given, read only that file; otherwise, read all files."""

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.