==============
Python reflink
==============
.. image:: https://img.shields.io/pypi/v/reflink.svg
:target: https://pypi.python.org/pypi/reflink
.. image:: https://gitlab.com/rubdos/pyreflink/badges/master/build.svg
:target: https://gitlab.com/rubdos/pyreflink/pipelines
.. image:: https://ci.appveyor.com/api/projects/status/ta2rn0irw52ua5sw?svg=true
:target: https://ci.appveyor.com/project/RubenDeSmet/pyreflink
:alt: Windows build status
.. image:: https://readthedocs.org/projects/reflink/badge/?version=latest
:target: https://reflink.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://readthedocs.org/projects/reflink/badge/?version=latest
:target: https://rubdos.gitlab.io/pyreflink/docs
:alt: Documentation Status
.. image:: https://gitlab.com/rubdos/pyreflink/badges/master/coverage.svg
:target: https://rubdos.gitlab.io/pyreflink/coverage
:alt: 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 <https://gitlab.com/rubdos/pyreflink/issues/1>`__
Support
_______
Support on `the GitLab repository <https://gitlab.com/rubdos/pyreflink/issues>`__,
feel free to file an issue.
Credits
---------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _pypi: https://pypi.python.org/pypi/reflink
=======
History
=======
0.2.0 (2018-03-09)
------------------
New features:
* APFS/Darwin support
* Filenames outside ascii are supported (thank you, Kriskras99)
Bug fixes:
* Building on newer glibc (thank you, Frankie Dintino)
* Better error handling for ENOENT
Other changes:
* Continuous integration for Windows (AppVeyor), integrated in the GitLab pipeline
0.1.0 (2017-07-27)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/rubdos/pyreflink",
"name": "reflink",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "reflink",
"author": "Ruben De Smet",
"author_email": "pypi@rubdos.be",
"download_url": "https://files.pythonhosted.org/packages/63/47/b503f286378336aa6d2fd3caad10633bb79f3bc6256f1f2f9102dacb3c98/reflink-0.2.2.tar.gz",
"platform": null,
"description": "==============\nPython reflink\n==============\n\n\n.. image:: https://img.shields.io/pypi/v/reflink.svg\n :target: https://pypi.python.org/pypi/reflink\n\n.. image:: https://gitlab.com/rubdos/pyreflink/badges/master/build.svg\n :target: https://gitlab.com/rubdos/pyreflink/pipelines\n\n.. image:: https://ci.appveyor.com/api/projects/status/ta2rn0irw52ua5sw?svg=true\n :target: https://ci.appveyor.com/project/RubenDeSmet/pyreflink\n :alt: Windows build status\n\n.. image:: https://readthedocs.org/projects/reflink/badge/?version=latest\n :target: https://reflink.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://readthedocs.org/projects/reflink/badge/?version=latest\n :target: https://rubdos.gitlab.io/pyreflink/docs\n :alt: Documentation Status\n\n.. image:: https://gitlab.com/rubdos/pyreflink/badges/master/coverage.svg\n :target: https://rubdos.gitlab.io/pyreflink/coverage\n :alt: Coverage report\n\n\nPython wrapper around the ``reflink`` system calls.\nNote: Python is implementing this natively upstream, cfr. https://bugs.python.org/issue37157.\n\n\n* Free software: MIT license\n* Documentation: https://reflink.readthedocs.io.\n* Documentation for master branch: https://rubdos.gitlab.io/pyreflink/docs\n\n\nFeatures\n--------\n\n* Btrfs, XFS, OCFS2 ``reflink`` support. Btrfs is tested the most.\n* Apple macOS APFS ``clonefile`` support. Little testing, be careful. It might eat data.\n* A convenience method that checks support for reflinks within a specific directory.\n\nInstallation\n------------\n\nThis library is available on `pypi`_::\n\n pip install reflink\n\nQuick start example\n-------------------\n\nTo use Python reflink in a project::\n\n from reflink import reflink\n # Reflink copy 'large_file.img' to 'copy_of_file.img'\n reflink(\"large_file.img\", \"copy_of_file.img\")\n\nHelp wanted\n-----------\n\nSomeone to implement a `Windows/ReFS implementation <https://gitlab.com/rubdos/pyreflink/issues/1>`__\n\n\nSupport\n_______\n\nSupport on `the GitLab repository <https://gitlab.com/rubdos/pyreflink/issues>`__,\nfeel free to file an issue.\n\nCredits\n---------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _pypi: https://pypi.python.org/pypi/reflink\n\n\n\n=======\nHistory\n=======\n\n0.2.0 (2018-03-09)\n------------------\n\nNew features:\n\n* APFS/Darwin support\n* Filenames outside ascii are supported (thank you, Kriskras99)\n\nBug fixes:\n\n* Building on newer glibc (thank you, Frankie Dintino)\n* Better error handling for ENOENT\n\nOther changes:\n\n* Continuous integration for Windows (AppVeyor), integrated in the GitLab pipeline\n\n0.1.0 (2017-07-27)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Python reflink wraps around platform specific reflink implementations",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://gitlab.com/rubdos/pyreflink"
},
"split_keywords": [
"reflink"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6347b503f286378336aa6d2fd3caad10633bb79f3bc6256f1f2f9102dacb3c98",
"md5": "5ca7432f31c16411e4bae75d0922295f",
"sha256": "882375ee7319275ae5f6a6a1287406365dac1e9643b91ad10e5187d3f84253bd"
},
"downloads": -1,
"filename": "reflink-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "5ca7432f31c16411e4bae75d0922295f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21956,
"upload_time": "2023-08-26T10:33:51",
"upload_time_iso_8601": "2023-08-26T10:33:51.565938Z",
"url": "https://files.pythonhosted.org/packages/63/47/b503f286378336aa6d2fd3caad10633bb79f3bc6256f1f2f9102dacb3c98/reflink-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-26 10:33:51",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "rubdos",
"gitlab_project": "pyreflink",
"lcname": "reflink"
}
JSON