Skip to content

Commit ae20dc5

Browse files
committed
docs: modify outdate infos
1 parent 4580c0b commit ae20dc5

File tree

4 files changed

+21
-25
lines changed

4 files changed

+21
-25
lines changed

MANIFEST.in

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
asyncodbc
22
=========
3-
.. image:: https://travis-ci.com/tortoise/asyncodbc.svg?branch=master
3+
.. image:: https://travis-ci.com/tortoise/asyncodbc.svg?branch=main
44
:target: https://travis-ci.com/tortoise/asyncodbc
5-
.. image:: https://coveralls.io/repos/tortoise/asyncodbc/badge.svg?branch=master&service=github
6-
:target: https://coveralls.io/github/tortoise/asyncodbc?branch=master
5+
.. image:: https://coveralls.io/repos/tortoise/asyncodbc/badge.svg?branch=main&service=github
6+
:target: https://coveralls.io/github/tortoise/asyncodbc?branch=main
77
.. image:: https://img.shields.io/pypi/v/asyncodbc.svg
88
:target: https://pypi.python.org/pypi/asyncodbc
99

10-
**asyncodbc** is a Python 3.5+ module that makes it possible to access ODBC_ databases
10+
**asyncodbc** is a Python 3.9+ module that makes it possible to access ODBC_ databases
1111
with asyncio_. It relies on the awesome pyodbc_ library and preserves the same look and
12-
feel. *asyncodbc* was written using `async/await` syntax (PEP492_) and thus is not compatible
13-
with Python versions older than 3.5. Internally *asyncodbc* employs threads to avoid
12+
feel. *asyncodbc* was written using `async/await` syntax (PEP492_) and only support
13+
Python that is not end-of-life(EOL). Internally *asyncodbc* employs threads to avoid
1414
blocking the event loop, threads_ are not that as bad as you think!. Other
1515
drivers like motor_ use the same approach.
1616

@@ -137,7 +137,7 @@ Run tests
137137
For testing purposes you need to install docker_ and the development
138138
requirements::
139139

140-
$ pip install -r requirements-dev.txt
140+
$ pip install -r pyproject.toml --group test -e .
141141

142142
In order to simplify development you should install the provided docker container.
143143
This way you don't need to install any databases or other system libraries, everything happens inside the container.
@@ -150,31 +150,31 @@ Then just execute::
150150
The test will automatically pull images and build containers with
151151
the required databases.
152152

153-
*NOTE:* Running tests requires Python 3.6 or higher.
153+
*NOTE:* Running tests requires Python 3.9 or higher.
154154

155155

156156
Other SQL Drivers
157157
-----------------
158158

159-
* aiopg_ - asyncio client for PostgreSQL
159+
* asyncpg_ - asyncio client for PostgreSQL
160160
* aiomysql_ - asyncio client form MySQL
161161

162162

163163
Requirements
164164
------------
165165

166-
* Python_ 3.5+
166+
* Python_ 3.9+
167167
* pyodbc_
168168
* uvloop_ (optional)
169169

170170

171171
.. _Python: https://www.python.org
172-
.. _asyncio: http://docs.python.org/3.4/library/asyncio.html
172+
.. _asyncio: http://docs.python.org/3.14/library/asyncio.html
173173
.. _pyodbc: https://github.com/mkleehammer/pyodbc
174174
.. _uvloop: https://github.com/MagicStack/uvloop
175175
.. _ODBC: https://en.wikipedia.org/wiki/Open_Database_Connectivity
176-
.. _aiopg: https://github.com/tortoise/aiopg
177-
.. _aiomysql: https://github.com/tortoise/aiomysql
176+
.. _asyncpg: https://github.com/MagicStack/asyncpg
177+
.. _aiomysql: https://github.com/aio-libs/aiomysql
178178
.. _PEP492: https://www.python.org/dev/peps/pep-0492/
179179
.. _unixODBC: http://www.unixodbc.org/
180180
.. _threads: http://techspot.zzzeek.org/2015/02/15/asynchronous-python-and-databases/

docs/index.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@ Welcome to asyncodbc's documentation!
88

99
.. _GitHub: https://github.com/tortoise/asyncodbc
1010
.. _asyncio: http://docs.python.org/3.14/library/asyncio.html
11+
.. _aioodbc: https://github.com/aio-libs/aioodbc
1112
.. _pyodbc: https://github.com/mkleehammer/pyodbc
1213
.. _PEP492: https://www.python.org/dev/peps/pep-0492/
14+
.. _ODBC: https://learn.microsoft.com/en-us/sql/odbc/microsoft-open-database-connectivity-odbc
1315
.. _unixODBC: http://www.unixodbc.org/
1416
.. _threads: http://techspot.zzzeek.org/2015/02/15/asynchronous-python-and-databases/
1517

16-
1718
**asyncodbc** is Python 3.9+ module that makes possible accessing ODBC_ databases
1819
with asyncio_. It is rely on awesome pyodbc_ library, preserve same look and
19-
feel. *asyncodbc* was written `async/await` syntax (PEP492_) thus not
20-
compatible with Python older then 3.5. Internally *asyncodbc* employ threads
20+
feel. *asyncodbc* was written using `async/await` syntax (PEP492_) and only support
21+
Python that is not end-of-life(EOL). Internally *asyncodbc* employs threads
2122
to avoid blocking the event loop, btw threads_ are not that bad as you think :)
2223

2324

@@ -40,7 +41,7 @@ or have some suggestion for library improvement.
4041

4142
The library uses `Travis <https://travis-ci.org/tortoise/asyncodbc>`_ for
4243
Continious Integration and `Coveralls
43-
<https://coveralls.io/r/tortoise/asyncodbc?branch=master>`_ for
44+
<https://coveralls.io/r/tortoise/asyncodbc?branch=main>`_ for
4445
coverage reports.
4546

4647

@@ -55,8 +56,8 @@ Dependencies
5556
Authors and License
5657
-------------------
5758

58-
The ``asyncodbc`` package is base on ``aioodbc`` which written by Nikolay Novik and aio-libs_ contributors.
59-
It's MIT licensed.
59+
The ``asyncodbc`` package is inspired by aioodbc_.
60+
It's Apache-2.0 licensed.
6061

6162
Feel free to improve this package and send a pull request to GitHub_.
6263

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ build-backend = "pdm.backend"
4040
version = {source="file", path="asyncodbc/__init__.py"}
4141

4242
[tool.pdm.build]
43-
excludes = ["./**/.git", "./**/.*_cache"]
43+
excludes = ["./**/.git", "./**/.*_cache", "./**/*.pyc", "./**/*.swp"]
4444
include = ["LICENSE", "README.rst"]
4545

4646
[tool.pytest.ini_options]

0 commit comments

Comments
 (0)