README.rst

dbConnect: Database for Humans

WHY?

dbConnect was made as a little module to be used in small projects that need to do some interactions with MySQL or PostgreSQL databases.

It's just a big time saver for developers specially for making data analyzing and data scraping and it helps to keep your code clean and readable by using python-like structure.

Installation

requirements:

dbConnect uses mysql.connector and mysqlclient modules for mysql, install one of them using:

$ apt-get install python3-mysql.connector
$ apt-get install python-mysql.connector

Or using offical site: https://dev.mysql.com/downloads/connector/python/

$ pip install mysqlclient

More details on mysqlclient: https://github.com/PyMySQL/mysqlclient-python

For PostgreSQL install psycopg2 module:

$ pip install psycopg2

using pip:

$ pip install dbConnect

from source code:

$ git clone git@gitlab.com:mastizada/dbConnect.git
$ cd dbConnect
$ sudo python setup.py install

Usage

Importing and making a connection:

>>> from dbConnect import DBConnect
>>> database = DBConnect(credentials.json)
>>> database.fetch('tableName', limit=5, filters={'company': 'pyninjas'})

Documentation

• Docs: http://dbconnect.readthedocs.org/

• Alternate Docs: https://pythonhosted.org/dbConnect/

• Check generated documentation using:

  $ pydoc3 dbConnect

  or

  $ pydoc3 -p 8000

  and open http://localhost:8000/ in browser

Enjoy