Navigation

  • index
  • modules |
  • next |
  • previous |
  • Python reflink documentation »
  • Python reflink

Python reflink¶

https://img.shields.io/pypi/v/reflink.svg https://gitlab.com/rubdos/pyreflink/badges/master/build.svg Windows build status Documentation Status Documentation Status Coverage report

Python wrapper around the reflink system calls. Note: Python is implementing this natively upstream, cfr. https://bugs.python.org/issue37157.

  • Free software: MIT license

  • Documentation: https://reflink.readthedocs.io.

  • Documentation for master branch: https://rubdos.gitlab.io/pyreflink/docs

Features¶

  • Btrfs, XFS, OCFS2 reflink support. Btrfs is tested the most.

  • Apple macOS APFS clonefile support. Little testing, be careful. It might eat data.

  • A convenience method that checks support for reflinks within a specific directory.

Installation¶

This library is available on pypi:

pip install reflink

Quick start example¶

To use Python reflink in a project:

from reflink import reflink
# Reflink copy 'large_file.img' to 'copy_of_file.img'
reflink("large_file.img", "copy_of_file.img")

Help wanted¶

Someone to implement a Windows/ReFS implementation

Support¶

Support on the GitLab repository, feel free to file an issue.

Credits¶

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

Table of Contents

  • Python reflink
    • Features
    • Installation
    • Quick start example
    • Help wanted
      • Support
    • Credits

Previous topic

Welcome to Python reflink’s documentation!

Next topic

Installation

This Page

  • Show Source

Quick search

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Python reflink documentation »
  • Python reflink
© Copyright 2024, Ruben De Smet. Created using Sphinx 7.3.7.