Skip to content

Commit

Permalink
Moved from md to rst for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
malexer committed Mar 31, 2018
1 parent f77edfb commit d2d40d1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
27 changes: 16 additions & 11 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
# spatialite
spatialite
==========

Wrapper for standard Python module `sqlite3` which adds SpatiaLite support.


## Requirement: mod_spatialite
Requirement: mod_spatialite
---------------------------

This module will try to load SpatiaLite extension in SQLite and thus requires
"mod_spatialite" being present.

Ubuntu:
Ubuntu::

$ apt-get install libsqlite3-mod-spatialite

macOS:
macOS::

$ brew install libspatialite


## Install
Install
-------

Using pip::

$ pip install spatialite

Usage
-----

## Usage
.. code-block:: python
```python
import spatialite
import spatialite
with spatialite.connect('sl_temp.db') as db:
print(db.execute('SELECT spatialite_version()').fetchone()[0])
```
with spatialite.connect('sl_temp.db') as db:
print(db.execute('SELECT spatialite_version()').fetchone()[0])
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
cwd = path.abspath(path.dirname(__file__))


with open(path.join(cwd, 'README.md'), encoding='utf-8') as f:
with open(path.join(cwd, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

setup(
Expand All @@ -15,7 +15,6 @@

description='Wrapper of sqlite3 module which adds SpatiaLite support.',
long_description=long_description,
long_description_content_type='text/markdown',
url='https://github.com/malexer/spatialite',

author='Alex (Oleksii) Markov',
Expand Down

0 comments on commit d2d40d1

Please sign in to comment.