Skip to main content

Random Access To Archived Resources Library

Project description

Random Access Read-Only Tar Mount (Ratarmount) Library

PyPI version Python Version Downloads License Changelog

This is the library used as backend by ratarmount (CLI). For a full description including motivation and performance comparisons, see ratarmount.

Table of Contents

  1. Installation
  2. Usage

Installation

PIP Package Installation

In many cases a simple pip install should work:

pip install ratarmountcore[full]

If there is trouble with one of the compression dependencies, first try installing it without dependencies:

pip install ratarmountcore

And if that works, only install those dependencies you need, e.g.:

pip install ratarmountcore[bzip2,gzip]

You can install the latest development version with:

python3 -m pip install --user --force-reinstall 'git+https://github.com/mxmlnkn/ratarmount.git@develop#egginfo=ratarmountcore&subdirectory=core'

Dependencies

Python 3.6+ and preferably pip 19.0+ are required. These should be preinstalled on most systems.

Ratarmountcore has as few required dependencies as necessary in order to cause the least troubles on all possible systems. This means that only uncompressed TAR and ZIP support will work by default. All optional dependencies are offered as extras.

Extras

Ratarmountcore offers these extras (optional dependencies):

  • full, bzip2, gzip, rar, xz, zip, zstd

Full includes all dependencies of the other extras. The zip extra is currently only a placeholder because the built-in zipfile module is being used.

In order to install one of these extract, append them in brackets:

python3 -m pip install --user ratarmount[bzip2]

If you are installing on a system for which there exists no manylinux wheel, then you'll have to install dependencies required to build from source:

sudo apt install python3 python3-pip fuse build-essential software-properties-common zlib1g-dev libzstd-dev liblzma-dev

Usage

This library offers an interface which is sufficient to work with FUSE. This MountSource interface has methods for listing paths and getting file metadata and contents.

The ratarmountcore library offers multiple implementations of MountSource for different archive formats:

  • SQLiteIndexedTar: This is the oldest and most powerful implementation. It supports fast access to files inside (compressed) TARs.
  • RarMountSource: An implementation for RARs using rarfile.
  • ZipMountSource: An implementation for ZIPs using zipfile.
  • FolderMountSource: An implementation taking an existing folder as input.

There also are these functional implementations of MountSource:

  • UnionMountSource: Takes multiple MountSource implementations and shows a merged view of their file hierarchy.
  • FileVersionLayer: Takes a MountSource as input, decodes the requested paths, also accepting <file>.version/<number> paths, and calls the methods of the MountSource with the given file version.
  • AutoMountLayer: Takes one MountSource, goes over all its files and mounts archives recursively in a similar manner to UnionMountSource.

The factory function open opens one of the archive MountSource implementations according to the file type.

Mount Source Class Diagram

Example

from ratarmountcore.factory import open_mount_source

archive = open_mount_source("foo.tar", recursive=True)
print(archive.list("/"))
info = archive.lookup("/bar")

print("Contents of /bar:")
with archive.open(info) as file:
    print(file.read())

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

ratarmountcore-0.9.0.tar.gz (158.2 kB view details)

Uploaded Source

Built Distribution

ratarmountcore-0.9.0-py3-none-any.whl (152.9 kB view details)

Uploaded Python 3

File details

Details for the file ratarmountcore-0.9.0.tar.gz.

File metadata

  • Download URL: ratarmountcore-0.9.0.tar.gz
  • Upload date:
  • Size: 158.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for ratarmountcore-0.9.0.tar.gz
Algorithm Hash digest
SHA256 14f2e8bb9b61fe626085215c72e8bd2ad6a1ab021302fdfaf69fbc2fe525ba2f
MD5 da74f3b6e44a761dfc422bc9b0947b09
BLAKE2b-256 c671f2fcb98674e9a9ecbd5db2fbb90c5cf95c69dd8c43c6684dd33c4a2d41ca

See more details on using hashes here.

File details

Details for the file ratarmountcore-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: ratarmountcore-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 152.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for ratarmountcore-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c9199c4f28e5e8a48300eb09cf883740ee62795f97bd545b904046c9a24e8e7
MD5 3710d72bdfe01d7ed148d6401191f11f
BLAKE2b-256 4a190eaa4b6c6dd4122d77f0963e38990e0ba1e0e9832fc546835aae64d21e22

See more details on using hashes here.

Supported by

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