Metadata-Version: 2.1
Name: piedpy
Version: 2022.1
Summary: Powerful Command-line toolkit for MySQL Database.
Home-page: https://piedpy.rtfd.io
Author: Gerrishon Sirere
Author-email: scalabli@pm.me
Maintainer: Scalabli.
Maintainer-email: scalabli@pm.me
License: MIT
Project-URL: Donate, https://ko-fi.com/scalabli
Project-URL: Documentation, https://piedpy.rtfd.io
Project-URL: Changes, https://piedpy.readthedocs.io/en/latest/changes.html
Project-URL: Source Code, https://github.com/scalabli/piedpy
Project-URL: Issue Tracker, https://github.com/scalabli/piedpy/issues/
Project-URL: Twitter, https://twitter.com/scalabli
Project-URL: Chat, https://gitter.im/scalabli
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: SQL
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: PyMySQL (>=0.9.2)
Requires-Dist: cli-helpers[styles] (>=2.0.1)
Requires-Dist: configobj (>=5.0.5)
Requires-Dist: cryptography (>=1.0.0)
Requires-Dist: pyaes (>=1.6.1)
Requires-Dist: quo (>=2022.3)
Requires-Dist: sqlparse (<0.5.0,>=0.3.0)
Provides-Extra: ssh
Requires-Dist: paramiko ; extra == 'ssh'

[![Downloads](https://pepy.tech/badge/piedpy)](https://pepy.tech/project/piedpy)
[![PyPI version](https://badge.fury.io/py/piedpy.svg)](https://badge.fury.io/py/piedpy)
[![Wheel](https://img.shields.io/pypi/wheel/piedpy.svg)](https://pypi.com/project/piedpy)
[![pyimp](https://img.shields.io/pypi/implementation/piedpy.svg)](https://pypi.com/project/piedpy)
[![RTD](https://readthedocs.org/projects/piedpy/badge/)](https://piedpy.readthedocs.io)
[![Twitter Follow](https://img.shields.io/twitter/follow/gerrishon_s.svg?style=social)](https://twitter.com/gerrishon_s)

`Forever Scalable`

**piedpy** is a Python based CLI toolkit for MySQL with auto-completion, key binders and syntax highlighting.

## Compatibility
piedpy works flawlessly  with Linux, OSX, and Windows and requires Python `3.8` or later. 


## Features

* Auto-completion
* Syntax highlighting
* Smart-completion (enabled by default) will suggest context-sensitive completion.
    - `SELECT * FROM <tab>` will only show table names.
    - `SELECT * FROM users WHERE <tab>` will only show column names.
* Support for multiline queries.
* Favorite queries with optional positional parameters. Save a query using
  `\fs alias query` and execute it with `\f alias` whenever you need.
* Timing of sql statements and table rendering.
* Config file is automatically created at ``~/.piedpyrc`` at first launch.
* Log every query and its results to a file (disabled by default).
* Pretty prints tabular data (with colors!)
* Support for SSL connections

## Getting Started
### Installation
You can install quo via the Python Package Index (PyPI)

```
pip install -U piedpy

```

### Usage

```console

piedpy --help
```
![Usage](https://github.com/scalabli/piedpy/blob/main/docs/images/usage.png)


### Configuration

For more information on using and configuring piedpy, [check out
our documentation](https://piedpy.rtfd.io).                      

## Donate🎁

In order to for us to maintain this project and grow our community of contributors.
[Donate](https://ko-fi.com/scalabli)

## Getting Help

### Community

For discussions about the usage, development, and the future of quo, please join our Google community

* [Community👨‍👩‍👦‍👦](https://groups.google.com/forum/#!forum/secretum)

## Resources

### Bug tracker

If you have any suggestions, bug reports, or annoyances please report them
to our issue tracker at 
[Bug tracker](https://github.com/scalabli/piedpy/issues/) or send an email to:

 📥 secretum@googlegroups.com


## License📑

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  
This software is licensed under the `MIT License`. See the [License](https://github.com/scalabli/piedpy/blob/master/LICENSE) file in the top distribution directory for the full license text.


## Code of Conduct
Code of Conduct is adapted from the Contributor Covenant,
version 1.2.0 available at
[Code of Conduct](http://contributor-covenant.org/version/1/2/0/)


