Skip to content

Commit

Permalink
minor changes to prepare the release
Browse files Browse the repository at this point in the history
  • Loading branch information
kimakan committed Nov 4, 2022
1 parent 458311b commit 9eeebee
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ or integrated into another project.


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

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

```bash

pip install queryparser-python3

```

Alternatively, you can clone the repository and install it from there.
Expand Down Expand Up @@ -56,7 +58,7 @@ Parsing MySQL and PostgreSQL
----------------------------

Parsing and processing of MySQL queries can be done by creating an instance
of the ``MySQLQueryProcessor`` class
of the `MySQLQueryProcessor` class

```python
from queryparser.mysql import MySQLQueryProcessor
Expand All @@ -76,9 +78,9 @@ and running it with
qp.process_query()
```

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

Alternatively, passing the query at initialization automatically processes it.

Expand All @@ -97,7 +99,7 @@ Translating ADQL
----------------

Translation of ADQL queries is done similarly by first creating an instance of
the ``ADQLQueryTranslator`` class
the `ADQLQueryTranslator` class

```python
from queryparser.adql import ADQLQueryTranslator
Expand All @@ -113,7 +115,7 @@ and calling

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


Testing
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
description=u'Parses PostgreSQL/MySQL and translates ADQL to ' +\
'PostgreSQL/MySQL.',
long_description=open('README.md').read(),
long_description_content_type='text/x-rst',
long_description_content_type='text/markdown',
install_requires=requirements,
classifiers=[],
packages=[
Expand Down

0 comments on commit 9eeebee

Please sign in to comment.