Metadata-Version: 2.1
Name: aiopathlib
Version: 0.1.0
Summary: Pathlib support for asyncio
Home-page: https://github.com/waketzheng/aiopathlib
License: MIT
Keywords: aiopathlib,asyncpath,aiopath
Author: Waket Zheng
Author-email: waketzheng@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: aiofiles (>=0.7.0,<0.8.0)
Project-URL: Repository, https://github.com/waketzheng/aiopathlib
Description-Content-Type: text/markdown

aiopathlib: Pathlib support for asyncio
==================================

**aiopathlib** is written in Python, for handling local
disk files in asyncio applications.

Base on `aiofiles` and just like pathlib, but use await.

.. code-block:: python

    with open('filename', 'w') as f:
        f.write('My file contents')

    text = await aiopathlib.AsyncPath('filename').read_text()
    print(text)
    'My file contents'

    content = await aiopathlib.AsyncPath(Path('filename')).read_bytes()
    print(cotent)
    b'My file contents'


Asynchronous interface to create folder.

.. code-block:: python

    await AsyncPath('dirname').mkdir(parents=True)


Features
--------

- a file API very similar to Python's standard package `pathlib`, blocking API
- support for buffered and unbuffered binary files, and buffered text files
- support for ``async``/``await`` (:PEP:`492`) constructs


Installation
------------

To install aiofiles, simply:

.. code-block:: bash

    $ pip install git+https://gitee.com/waketzheng/aiopathlib.git


Usage
-----


* ``read_text``
* ``read_bytes``
* ``read_json``
* ``write_text``
* ``write_bytes``
* ``write_json``
* ``mkdir``
* ``exists``
* ``rename``
* ``remove``


History
~~~~~~~

0.1.0 (2021-06-13)
``````````````````

- Introduced a changelog.
- Publish at gitee.


Contributing
~~~~~~~~~~~~
Contributions are very welcome.

