Skip to content

Commit ebe362e

Browse files
committed
Update long description in setup.py
1 parent ad61ca1 commit ebe362e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

setup.py

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,32 @@
1212
__version__ = line.split('=')[1].strip().strip("'").strip('"')
1313
break
1414

15+
long_description = \
16+
"""Current state: **alpha**, yet API seems fine and mostly stable.
17+
18+
In current version (0.5.x) new-high level API is introduced while older low-level API partially marked as deprecated.
19+
20+
* Works on Python 3.4+
21+
* Has support for PostgreSQL via `aiopg`
22+
* Has support for MySQL via `aiomysql`
23+
* Single point for high-level async API
24+
* Drop-in replacement for sync code, sync will remain sync
25+
* Basic operations are supported
26+
* Transactions support is present, yet not heavily tested
27+
28+
The source code is hosted on `GitHub`_.
29+
30+
.. _GitHub: https://github.com/05bit/peewee-async
31+
"""
32+
1533
setup(
1634
name="peewee-async",
1735
version=__version__,
1836
author="Alexey Kinev",
1937
author_email='[email protected]',
2038
url='https://github.com/05bit/peewee-async',
2139
description=__doc__,
22-
# long_description=__doc__,
40+
long_description=long_description,
2341
license='MIT',
2442
zip_safe=False,
2543
install_requires=(

0 commit comments

Comments
 (0)