summaryrefslogtreecommitdiff
path: root/README.rst
blob: 06b9e03d22542061494ea1815f64bf23fcf9c26a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
python-sqlparse - Parse SQL statements
======================================

sqlparse is a non-validating SQL parser module for Python.

|buildstatus|_
|coverage|_


Install
-------

From pip, run::

    $ pip install --upgrade sqlparse

Consider using the ``--user`` option_.

.. _option: https://pip.pypa.io/en/latest/user_guide/#user-installs

From the repository, run::

  python setup.py install

to install python-sqlparse on your system.

python-sqlparse is compatible with Python 2.7 and Python 3 (>= 3.3).


Run Tests
---------

To run the test suite run::

  tox

Note, you'll need tox installed, of course.


Links
-----

Project Page
  https://github.com/andialbrecht/sqlparse

Documentation
  https://sqlparse.readthedocs.io/en/latest/

Discussions
  http://groups.google.com/group/sqlparse

Issues/Bugs
  https://github.com/andialbrecht/sqlparse/issues

Online Demo
  http://sqlformat.org


python-sqlparse is licensed under the BSD license.

Parts of the code are based on pygments written by Georg Brandl and others.
pygments-Homepage: http://pygments.org/

.. |buildstatus| image:: https://secure.travis-ci.org/andialbrecht/sqlparse.png?branch=master
.. _buildstatus: http://travis-ci.org/#!/andialbrecht/sqlparse
.. |coverage| image:: https://coveralls.io/repos/andialbrecht/sqlparse/badge.svg?branch=master&service=github
.. _coverage: https://coveralls.io/github/andialbrecht/sqlparse?branch=master