devansh3712/pysql

Python wrapper for making MySQL queries easier

PySQL

Python wrapper for making MySQL queries easier to execute

---

Installation

• Clone the repository to your local machine

git clone https://github.com/Devansh3712/PySQL.git

• Installation pre-requisites

  • MySQL local server

• PyPi package

Windows

pip install pysql-cli

Linux / MacOS

pip3 install pysql-cli

• Automatic Installation

Open the PySQL directory and run the install file

Windows

install.bat

Linux / MacOS

chmod +x ./install.sh
./install.sh

• Manual Setup

Open the PySQL directory

using requirements.txt

pip install -r requirements.txt

Usage

• Using the pip package

  • pysql: Basic PySQL CLI
  • cpysql: Colored PySQL CLI

pysql
cpysql

• Using the Python command-line wrapper .py file

  • main.py: Basic PySQL CLI
  • main_c.py: Colored PySQL CLI

Windows

python pysql/main.py
python pysql/main_c.py

Linux

python3 pysql/main.py
python3 pysql/main_c.py

Commands

List of available commands

ALL COMMANDS

    select              TB_NAME, COLUMNS, ARGS      Displays selected columns of a table
    insert      -s      TB_NAME, ARGS               Insert a single row in a table
                -m      TB_NAME, NUM, ARGS          Insert `NUM` rows in a table
                -f      TB_NAME, FILE_NAME          Insert values in a table from CSV file
    update              TB_NAME, COLUMNS, ARGS      Updates values of columns in a table
    delete              TB_NAME, COLUMN             Deletes values of row in a table
    showdb                                          Display all databases in MySQL server
    usedb                                           Use a database
    createdb            DB_NAME                     Create a new database
    dropdb              DB_NAME                     Delete a database
    showtb                                          Display all tables in current db
    createtb            TB_NAME, ARGS               Create a new table in current db
    droptb              TB_NAME                     Delete a table in current db
    trunctb             TB_NAME                     Truncate a table in current db
    desctb              TB_NAME                     Display structure of a table in current db
    altertb             TB_NAME, ARGS               Alter contents of table in current db
    exportdb            DB_NAME, PATH               Export db as `.sql` file to path
    exporttb    -json   TB_NAME, PATH               Export table as `.txt` file to path
                -csv    TB_NAME, PATH               Export table as `.csv` file to path
                -sql    TB_NAME, PATH               Export table schema as `.sql` file to path
    exportall   -json   PATH                        Export all tables in db as `.txt` file to path
                -csv    PATH                        Export all tables in db as `.csv` file to path
                -sql    PATH                        Export all tables schema in db as `.sql` file to path
    importdb            DB_NAME, PATH               Import `.sql` file into input database
    importtb            DB_NAME, PATH               Import `.sql` table schema into input table

pysql's Issues

No blank lines allowed after function docstring

Description

There shouldn't be any blank lines after the function docstring. Remove the blank lines to fix this issue. #### Not preferred: python def example(): '''Bad docstring.''' pass #### Preferred: python def example(): '''Good docstring.''' pass

Occurrences

There are 16 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-D202/occurrences/

No blank lines allowed before class docstring

Description

There shouldn't be any blank lines before the class docstring. Remove the blank lines to fix this issue. #### Not preferred: python class Example: '''Bad docstring.''' #### Preferred: python class Example: '''Good docstring.'''

Occurrences

There are 3 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-D211/occurrences/

First word of the first line should be properly capitalized

Description

It is recommended to capitalize the first word of the docstring.

Occurrences

There are 13 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-D403/occurrences/

Use of single quote detected in docstring

Description

Use of triple-quotes is recommended to specify docstrings.

Occurrences

There are 21 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-D300/occurrences/

Inconsistent return statements

Description

According to PEP8, if any return statement returns an expression, any return statements where no value is returned should explicitly state this as return None, and an explicit return statement should be present at the end of the function (if reachable). Good: ```python def foo(x): if x >= 0: return …

Occurrences

There are 2 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/PYL-R1710/occurrences/

Expected 2 blank lines after end of function or class

Description

Functions and classes should have two blank lines after them, separating them from other functions and classes.

Occurrences

There are 2 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-E305/occurrences/

Block comment should start with `#`

Description

Block comments should have one space before the pound sign # and the comment itself.

Occurrences

There are 24 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-E265/occurrences/

Blank line contains whitespace

Description

Blank lines should not contain any tabs or spaces.

Occurrences

There are 10 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-W293/occurrences/

No newline at end of file

Description

It is recommended to put a newline at the end of the file.

Occurrences

There are 2 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-W292/occurrences/

No blank lines allowed before function docstring

Description

There shouldn't be any blank lines before the function docstring. Remove the blank lines to fix this issue. #### Not preferred: python def example(): '''Bad docstring.''' ... #### Preferred: python def example(): '''Good docstring.''' ...

Occurrences

There are 16 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Devansh3712/PySQL/issue/FLK-D201/occurrences/