Skip to content

Commit 9eeebee

Browse files
committed
minor changes to prepare the release
1 parent 458311b commit 9eeebee

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ or integrated into another project.
1010

1111

1212
[![pytest Workflow Status](https://github.com/aipescience/queryparser/actions/workflows/pytest.yml/badge.svg)](https://github.com/aipescience/queryparser/actions/workflows/pytest.yml)
13-
[![Coverage Status](https://coveralls.io/repos/aipescience/queryparser/badge.svg?branch=dev&service=github)](https://coveralls.io/github/aipescience/queryparser?branch=dev)
13+
[![Coverage Status](https://coveralls.io/repos/aipescience/queryparser/badge.svg?branch=master&service=github)](https://coveralls.io/github/aipescience/queryparser?branch=master)
1414
[![License](http://img.shields.io/badge/license-APACHE-blue.svg?style=flat)](https://github.com/aipescience/queryparser/blob/master/LICENSE)
1515
[![Latest Version](https://img.shields.io/pypi/v/queryparser-python3.svg?style=flat)](https://pypi.org/project/queryparser-python3/)
1616

@@ -22,7 +22,9 @@ Installation
2222
The easiest way to install the package is by using the pip tool:
2323

2424
```bash
25+
2526
pip install queryparser-python3
27+
2628
```
2729

2830
Alternatively, you can clone the repository and install it from there.
@@ -56,7 +58,7 @@ Parsing MySQL and PostgreSQL
5658
----------------------------
5759

5860
Parsing and processing of MySQL queries can be done by creating an instance
59-
of the ``MySQLQueryProcessor`` class
61+
of the `MySQLQueryProcessor` class
6062

6163
```python
6264
from queryparser.mysql import MySQLQueryProcessor
@@ -76,9 +78,9 @@ and running it with
7678
qp.process_query()
7779
```
7880

79-
After the processing is completed, the processor object ``qp`` will include
81+
After the processing is completed, the processor object `qp` will include
8082
tables, columns, functions, and keywords used in the query or will raise a
81-
``QuerySyntaxError`` if there are any syntax errors in the query.
83+
`QuerySyntaxError` if there are any syntax errors in the query.
8284

8385
Alternatively, passing the query at initialization automatically processes it.
8486

@@ -97,7 +99,7 @@ Translating ADQL
9799
----------------
98100

99101
Translation of ADQL queries is done similarly by first creating an instance of
100-
the ``ADQLQueryTranslator`` class
102+
the `ADQLQueryTranslator` class
101103

102104
```python
103105
from queryparser.adql import ADQLQueryTranslator
@@ -113,7 +115,7 @@ and calling
113115

114116
which returns a translated string representing a valid MySQL query if
115117
the ADQL query had no errors. The MySQL query can then be parsed with the
116-
``MySQLQueryProcessor`` in the same way as shown above.
118+
`MySQLQueryProcessor` in the same way as shown above.
117119

118120

119121
Testing

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
description=u'Parses PostgreSQL/MySQL and translates ADQL to ' +\
2929
'PostgreSQL/MySQL.',
3030
long_description=open('README.md').read(),
31-
long_description_content_type='text/x-rst',
31+
long_description_content_type='text/markdown',
3232
install_requires=requirements,
3333
classifiers=[],
3434
packages=[

0 commit comments

Comments
 (0)