https://github.com/twisted/txmongo
asynchronous python driver for mongo
https://github.com/twisted/txmongo
python
Last synced: 17 days ago
JSON representation
asynchronous python driver for mongo
- Host: GitHub
- URL: https://github.com/twisted/txmongo
- Owner: twisted
- License: apache-2.0
- Created: 2009-09-26T06:00:05.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T10:15:35.000Z (18 days ago)
- Last Synced: 2025-03-28T19:43:57.382Z (17 days ago)
- Topics: python
- Language: Python
- Homepage: https://txmongo.readthedocs.io
- Size: 1.3 MB
- Stars: 338
- Watchers: 23
- Forks: 102
- Open Issues: 21
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
- awesome-mongodb - TxMongo - Twisted's MongoDB driver (Libraries / Python)
README
TxMongo
=======
.. image:: https://github.com/twisted/txmongo/actions/workflows/tests-on-push.yml/badge.svg
:target: https://github.com/twisted/txmongo/actions/workflows/tests-on-push.yml
.. image:: https://coveralls.io/repos/twisted/txmongo/badge.svg?branch=master
:target: https://coveralls.io/r/twisted/txmongo?branch=master
.. image:: https://badge.fury.io/py/txmongo.png
:target: https://pypi.python.org/pypi/txmongo
.. image:: https://readthedocs.org/projects/txmongo/badge/?version=latest
:target: https://txmongo.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
TxMongo is an asynchronous Python/Twisted driver for MongoDB that implements the wire
protocol on non-blocking sockets. The API derives from the original PyMongo.
Compatibility
-------------
Python 3.8+
MongoDB 4.0+
Installing
----------
You can use setuptools to install:
```sh
sudo python setup.py install
```
Docs and examples
-----------------
Generate them with `make docs`. You will need `sphinx` installed.
There are some examples in the *examples/* directory.
Hacking
-------
Run `make env` to create clean hacking environment with `virtualenv`.
Run `make` to torture your code with tests and code style tools.
Take a look in Makefile for commonly used commands and tools we use to develop.
Packages
--------
Debian
^^^^^^
Packing for debian exists in *debian/*, you can build yourself a package
(remember to update debian/changelog) if you make changes.
```sh
dpkg-buildpackage -b
```
Then look for the package in your home directory.
Fedora
^^^^^^
```sh
rpmbuild -bb python-txmongo.spec
```
You might need to download Source0 from the .spec and place it in
rpmbuild/SOURCES first.