Skip to content
This repository has been archived by the owner on Jul 16, 2022. It is now read-only.

Commit

Permalink
Update README and change status to Alpha
Browse files Browse the repository at this point in the history
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
  • Loading branch information
miurahr committed Sep 20, 2020
1 parent 86dee7f commit 781d848
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 20 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,18 @@ multivolumefile
:target: https://github.com/miurahr/multivolume/actions

MultiVolumefile is a python library to provide a file-object wrapping multiple files
as virtually like as a single file.
as virtually like as a single file. It inherit io.RawIOBase class and support some of
its standard methods.

See API details at `python library reference`_

.. _`python library reference`: https://docs.python.org/3/library/io.html

Status
======

multivolumefile module is under active development and considered as ***Alpha*** state.
It is not good idea to use it on production systems.

Install
=======
Expand Down Expand Up @@ -47,6 +58,14 @@ Usages
you will see file `archive.7z.001` are written.

Limitations and known issues
============================

- fileno() is not supported and when call it, you will get RuntimeError exception.

- Extension of volume name is currently 4-digit of decimal number, start from 1, such as '0001', '0002' and so on.

- ***Caution***: When globbing existent volumes, it glob all files other than 4-digit extensions, it may break your data.

Contribution
============
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ author = Hiroshi Miura
author_email = miurahr@linux.com
url = https://github.com/miurahr/multivolume
classifiers =
Development Status :: 2 - Pre-Alpha
Development Status :: 3 - Alpha
Environment :: Console
License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Operating System :: MacOS :: MacOS X
Expand Down

0 comments on commit 781d848

Please sign in to comment.