pythonGrid

Datagrid for Python Web Frameworks

pythongridstg

Install Python

· ·

First of all, if you don’t have Python installed on your computer, download and install it from the Python official website now.

To make sure your Python is functional, type python3 in a terminal window, or just python if that does not work. Here is what you should expect to see:

Python 3.6.3 (v3.6.3:2c5fed86e0, Oct  3 2017, 00:32:08)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>

Creating the Sample Database

· ·

Find the sample database in folder sampledb. Run the sample SQL script Using your favorite Postgres or MySQL client (more database supports are coming).

For Postgres, PgAdmin is an excellent GUI client. For MySQL, you cannot go wrong with the hand dandy MySQL Workbench.

Steps to create the sample database:

  1. Create a new database named sampledb
  2. Run the sample SQL script for the database of your choice.

Installation

· ·

To install pythonGrid, a couple of quick start options are available:

git clone https://github.com/pycr/pythongrid.git

Folder Structure

Within the download you will see something like this:

├── LICENSE
├── README.md
├── app
│   ├── __init__.py
│   ├── data.py
│   ├── grid.py
│   ├── routes.py
│   ├── static
│   └── templates
│       ├── 404.html
│       ├── base.html
│       ├── grid.html
│       └── index.html
├── sample
│   ├── sampledb_postgres.sql
│   ├── sampledb_mysql.sql
├── config.py
├── index.py
└── requirements.txt

pythonGrid current has two main files in grid.py and data.py in app folder.

  • grid.py is the main Python class that is responsible for creating the datagrid table. It relies on jqGrid, a popular jQuery datagrid plugin, to render grids in the browser.
  • data.py is a Python class that returns the data via AJAX to populate the grid from a database.
  • static contains all of the client side Javascript and CSS files used for rendering

Introduction

· ·

Intended Audience: Web Developers
Programming Language: Python 3.6+,
Frameworks: Flask, Django,
Database: Postgres, MySQL

One of the main design goals of pythonGrid is to make creating datagrid easy for Python web apps, which means easy to install, minimum coding, and good flexibility for customization.

If you are new to Python web development, consider starting with Flask, a micro MVC framework that is easy to learn, and the excellent Flask Mega Tutorial by Miguel Grinberg.

You will need either Postgres or MySQL database, both can be easily set up in a local development environment.

If the local install is not your thing, Docker has you covered.

Let’s start!