Release v\ |release| (:ref:`What's new? <release_history>`).

.. include:: ../../README.rst


Install
------------------------------------------------------------------------------

``s3pathlib`` is released on PyPI, so all you need is:

.. code-block:: console

    $ pip install s3pathlib

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade s3pathlib


Comprehensive Guide
------------------------------------------------------------------------------

.. toctree::
    :maxdepth: 1
    :caption: Table of Content

    01-Pure-S3-Path-Manipulation.ipynb
    02-S3-Read-API.ipynb
    03-S3-Write-API.ipynb
    04-Example-App-Sync-Two-S3-Folders.ipynb
    05-Example-App-Reinvent-Cloud-Drive.ipynb


API Document
------------------------------------------------------------------------------

* :ref:`by Name <genindex>`
* :ref:`by Structure <modindex>`