mirrors
/
pgcli
mirror of https://github.com/dbcli/pgcli
1
0
Fork 0
Code

Readme formatting.

This commit is contained in:
Amjith Ramanujam 2014-11-30 22:27:18 -08:00
parent 3d9c2b0b87
commit e73e05e392
1 changed files with 45 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.rst
View File

@ -6,12 +6,8 @@ This is a postgres client that does auto-completion and syntax highlighting.
.. image:: screenshots/image02.png
.. image:: screenshots/image01.png
Installation
============
If you don't know how to install python pacakges, please check the `detailed instructions`__.
__ https://github.com/amjith/pgcli#detailed-installation-instructions
Quick Start
-----------
If you already know how to install python pacakges, then you can simply do:
@ -19,12 +15,52 @@ If you already know how to install python pacakges, then you can simply do:
$ pip install pgcli
If you don't know how to install python pacakges, please check the `detailed instructions`__.
__ https://github.com/amjith/pgcli#detailed-installation-instructions
Usage
-----
::
$ pgcli [database_name]
or
$ pgcli postgresql://[user[:password]@][netloc][:port][/dbname]
Examples:
::
$ pgcli local_database
$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db
Features
--------
The `pgcli` is written using prompt_toolkit_.
* Auto-completion as you type for SQL keywords as well as tables and
columns in the database.
* Syntax highlighting using Pygments.
* 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.
* Config file is automatically created at ~/.pglirc at first launch.
* Primitive support for `psql` back-slash commands.
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit
Detailed Installation Instructions:
===================================
-----------------------------------
OS X:
-----
=====
For installing Python pacakges it is recommended to use the package manager
called `pip`. Check if `pip` is installed on the system.
@ -55,7 +91,7 @@ If pip is not installed check if easy_install is available on the system.
$ sudo easy_install pgcli
Linux:
------
======
Check if pip is already available in your system.
@ -86,40 +122,3 @@ Then you can install pgcli:
$ sudo pip install pgcli
Usage
=====
::
$ pgcli [database_name]
or
$ pgcli postgresql://[user[:password]@][netloc][:port][/dbname]
Examples:
::
$ pgcli local_database
$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db
Features
========
The `pgcli` is written using prompt_toolkit_.
* Auto-completion as you type for SQL keywords as well as tables and
columns in the database.
* Syntax highlighting using Pygments.
* 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.
* Config file is automatically created at ~/.pglirc at first launch.
* Primitive support for `psql` back-slash commands.
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit