Skip to content

Commit

Permalink
Add README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ivknv committed Sep 24, 2017
1 parent 868abd7 commit 1feefe3
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
include LICENSE.txt
include README.rst
59 changes: 59 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
S3M
===
S3M - is a sqlite3 wrapper for multithreaded python applications.

Table of contents
#################

1. Multithreading_
2. Documentation_
3. Installation_
4. Usage_

.. _Multithreading:

Multithreading support
######################

S3M prevents multiple database operations (or transactions, can be disabled) from running at once.
That's basically the whole point of this library.

.. _Documentation:

Documentation
#############
.. _Read the Docs: http://s3m.readthedocs.io

Documentation is available at `Read the Docs`_

.. _Installation:

Installation
############

.. code:: sh
pip install s3m
or

.. code:: sh
python setup.py install
There are no requirements.

.. _Usage:

Usage
#####
The usage is similar to `sqlite3` with a few exceptions.

There is no cursor()
--------------------
You never have to use cursors. `s3m.Connection` object is completely self-sufficent, it has the methods of both a connection and a cursor.

Connections can be freely shared between threads (given `check_same_thread=False`)
----------------------------------------------------------------------------------
Multiple threads can use the same connection at the same time without any problems, that is, assuming that the connection was created with `check_same_thread=False`.
8 changes: 8 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-

import codecs
import os
from setuptools import setup

module_dir = os.path.dirname(__file__)

with codecs.open(os.path.join(module_dir, "README.rst"), encoding="utf8") as f:
long_description = f.read()

setup(name="s3m",
version="1.0.3",
py_modules=["s3m"],
description="sqlite3 wrapper for multithreaded applications",
long_description=long_description,
author="Ivan Konovalov",
author_email="rvan.mega@gmail.com",
url="https://github.com/SPython/s3m",
Expand Down

0 comments on commit 1feefe3

Please sign in to comment.