Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/releases/upcoming/237.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document the ``apptools.io`` and ``apptools.io.h5`` sub packages (#237)
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ AppTools Documentation
undo/*
selection/*
naming/*
io/*
api

* :ref:`search`
28 changes: 28 additions & 0 deletions docs/source/io/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
File I/O
========

The :mod:`apptools.io` package provides a traited |File| object provides
properties and methods for common file path manipulation operations. Much of
this functionality was implemented before Python 3 `pathlib`_ standard library
became available to provide similar support. For new code we encourage users
to investigate if `pathlib`_ can satisfy their use cases before they turn to
the `apptools.io` |File| object

HDF5 File Support
-----------------

The :mod:`apptools.io.h5` sub-package provides a wrapper around `PyTables`_
with a dictionary-style mapping.


..
external links

.. _pathlib: https://docs.python.org/3/library/pathlib.html
.. _PyTables: https://www.pytables.org/


..
# substitutions

.. |File| replace:: :class:`~apptools.io.file.File`