Skip to content

Commit b3475bd

Browse files
committed
Minor documentation fixes.
1 parent 7168e5c commit b3475bd

File tree

4 files changed

+19
-22
lines changed

4 files changed

+19
-22
lines changed

CHANGELOG

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Internal Changes
109109

110110

111111
Release 0.2.1 (Aug 13, 2016)
112-
---------------------------
112+
----------------------------
113113

114114
Notable Changes
115115

README.rst

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,32 @@ sqlparse is a non-validating SQL parser module for Python.
1010
Install
1111
-------
1212

13-
From pip, run::
13+
Using pip::
1414

15-
$ pip install --upgrade sqlparse
16-
17-
Consider using the ``--user`` option_.
18-
19-
.. _option: https://pip.pypa.io/en/latest/user_guide/#user-installs
15+
$ pip install sqlparse
2016

2117
From the repository, run::
2218

2319
python setup.py install
2420

25-
to install python-sqlparse on your system.
26-
27-
python-sqlparse is compatible with Python 2.7 and Python 3 (>= 3.3).
21+
to install sqlparse on your system.
2822

23+
sqlparse is compatible with Python 2.7 and Python 3 (>= 3.4).
2924

30-
Run Tests
31-
---------
3225

33-
To run the test suite run::
26+
Quick Start
27+
-----------
3428

35-
tox
36-
37-
Note, you'll need tox installed, of course.
29+
code-block:: python
3830

31+
>>> import sqlparse
32+
>>> # Split a string containing two SQL statements:
33+
>>> statements = sqlparse.split('select * from foo; select * from bar;')
34+
>>> # Format the first statement and print it out:
35+
>>> print(sqlparse.format(statements[0], reindent=True, keyword_case='upper'))
36+
SELECT *
37+
FROM foo;
38+
>>>
3939

4040
Links
4141
-----
@@ -46,17 +46,14 @@ Project Page
4646
Documentation
4747
https://sqlparse.readthedocs.io/en/latest/
4848

49-
Discussions
50-
https://groups.google.com/forum/#!forum/sqlparse
51-
5249
Issues/Bugs
5350
https://github.com/andialbrecht/sqlparse/issues
5451

5552
Online Demo
5653
https://sqlformat.org/
5754

5855

59-
python-sqlparse is licensed under the BSD license.
56+
sqlparse is licensed under the BSD license.
6057

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

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ python-sqlparse
99
:mod:`sqlparse` is a non-validating SQL parser for Python.
1010
It provides support for parsing, splitting and formatting SQL statements.
1111

12-
The module is compatible with Python 2.7 and Python 3 (>= 3.3)
12+
The module is compatible with Python 2.7 and Python 3 (>= 3.4)
1313
and released under the terms of the `New BSD license
1414
<https://opensource.org/licenses/BSD-3-Clause>`_.
1515

docs/source/intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ SQL statements can be beautified by using the :meth:`~sqlparse.format` function.
4848
.. code-block:: python
4949
5050
>>> sql = 'select * from foo where id in (select id from bar);'
51-
>>> print sqlparse.format(sql, reindent=True, keyword_case='upper')
51+
>>> print(sqlparse.format(sql, reindent=True, keyword_case='upper'))
5252
SELECT *
5353
FROM foo
5454
WHERE id IN

0 commit comments

Comments
 (0)