Skip to content

Commit 15edcb2

Browse files
authored
Update README.rst
1 parent 5cc9b2d commit 15edcb2

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,27 @@ FileFormats
1616

1717

1818
*Fileformats* provides a library of file-format types implemented as Python classes.
19-
The file-format types are designed to be used in type validation during the construction
20-
of data workflows (e.g. Pydra_, Fastr_), and also provide some basic data handling methods
21-
(e.g. loading data to dictionaries) and conversions between some equivalent types When
22-
the "extended" install option is provided.
19+
The file-format types were designed to be used in type validation and data movement
20+
during the construction and execution of data workflows. However, they can can also be
21+
used some basic data handling methods (e.g. loading data to dictionaries) and format
22+
conversions between some equivalent types via methods defined in the associated `fileformats-extras <https://pypi.org/project/fileformats-extras/>`__
23+
package.
2324

2425
File-format types are typically identified by a combination of file extension
25-
and "magic numbers" where applicable, however, unlike many other file-type Python packages,
26+
and "magic numbers" where applicable. However, unlike many other file-type Python packages,
2627
*FileFormats*, supports multi-file data formats ("file sets") often found in scientific
2728
workflows, e.g. with separate header/data files. *FileFormats* also provides a flexible
2829
framework to add custom identification routines for exotic file formats, e.g.
2930
formats that require inspection of headers to locate data files, directories containing
3031
certain file types, or to peek at metadata fields to define specific sub-types
31-
(e.g. functional MRI DICOM file set).
32+
(e.g. functional MRI DICOM file set). It is in the handling of multi-file formats that
33+
fileformats comes into its own, as it keeps track of auxiliary files when moving/copying
34+
to different file-system locations or calculating hashes.
3235

3336
See the `extension template <https://github.com/ArcanaFramework/fileformats-extension-template>`__
3437
for instructions on how to design *FileFormats* extensions modules to augment the
3538
standard file-types implemented in the main repository with custom domain/vendor-specific
36-
file-format types.
39+
file-format types (e.g. `fileformats-medimage <https://pypi.org/project/fileformats-medimage/>`__).
3740

3841
Notes on MIME-type coverage
3942
---------------------------
@@ -44,9 +47,7 @@ extensions and magic numbers. As such, many of the formats in the library have n
4447
tested on real data and so should be treated with some caution. If you encounter any issues with an implemented file
4548
type, please raise an issue in the `GitHub tracker <https://github.com/ArcanaFramework/fileformats/issues>`__.
4649

47-
Adding support for vendor formats will be relatively straightforward, it just requires someone to do the job
48-
of manually curating the scraped data (a days work or so). Please get in touch if you are interested in helping out
49-
with this.
50+
Adding support for vendor formats will be relatively straightforward and is planned for v1.0.
5051

5152

5253
Installation
@@ -60,11 +61,11 @@ Installation
6061
6162
6263
Support for converter methods between a few select formats can be installed by
63-
passing the 'extended' install extra, e.g
64+
passing the 'extras' package, e.g
6465

6566
.. code-block:: bash
6667
67-
$ python3 -m pip install fileformats[extended]
68+
$ python3 -m pip install fileformats-extras
6869
6970
7071
Examples

0 commit comments

Comments
 (0)