Merge pull request #64 from nowsecure/pypi-release

PyPI release
nowsecure · May 13, 2015 · a8806ba · a8806ba
2 parents 0d261b6 + 958bfa1
commit a8806ba
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,5 +43,8 @@ output/*/index.html
 # Sphinx
 docs/_build
 
+# PyCharm
+.idea
+
 # Filebrowser examples database
 examples/filebrowser/filebrowser.sqlite
diff --git a/DESCRIPTION.rst b/DESCRIPTION.rst
@@ -0,0 +1,23 @@
+=============
+datagrid_gtk3
+=============
+
+.. image:: https://semaphoreci.com/api/v1/projects/bd20f827-7591-4c58-87bb-e9235fdb9a0a/422070/shields_badge.svg
+    :target: https://semaphoreci.com/nowsecure/datagrid-gtk3
+
+.. image:: https://coveralls.io/repos/nowsecure/datagrid-gtk3/badge.svg
+    :target: https://coveralls.io/r/nowsecure/datagrid-gtk3
+
+
+SYNOPSIS
+========
+
+MVC framework for working with the Gtk3 TreeView widget.
+Includes classes for file browsing and displaying SQLite databases.
+
+
+MOTIVATION
+==========
+
+Created on the account of the reoccurring need to display and interact with
+contents of SQLite databases in Gtk applications.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,9 +1,9 @@
 .. :changelog:
 
 History
--------
+=======
 
 0.1.2 (2015-04-28)
----------------------
+------------------
 
 * Initial public release.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,16 +3,17 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to datagrid-gtk3's documentation!
-======================================
+.. include:: ../DESCRIPTION.rst
 
-Contents:
+Contents
+========
 
 .. toctree::
    :maxdepth: 2
 
-   readme
+   screenshots
    installation
+   usage
    contributing
    authors
    history

diff --git a/docs/readme.rst b/docs/readme.rst
diff --git a/docs/screenshots.rst b/docs/screenshots.rst
@@ -0,0 +1,34 @@
+
+Screenshots
+===========
+
+"Chinook" example
+-----------------
+
+.. figure:: screenshots/table_view.png
+    :alt: Table view
+
+    Displaying a table from an SQLite database with text filtering.
+
+.. figure:: screenshots/date_ranges.png
+    :alt: Date ranges.
+
+    Displaying a table from an SQLite database with date range filtering.
+
+
+"Filebrowser" example
+---------------------
+
+.. figure:: screenshots/icon_view.png
+    :alt: Icon view
+
+    Browsing the file system in icon view mode with thumbnails.
+
+
+"Selectable" example
+--------------------
+
+.. figure:: screenshots/row_selection.png
+    :alt: Row selection
+
+    Persistent row selection in SQLite databases.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -0,0 +1,19 @@
+
+Usage
+=====
+
+The basic usage scenario looks like this:
+
+.. code-block:: python
+
+    win = Gtk.Window()
+
+    data_source = SQLiteDataSource(db_path, table_name)
+    datagrid_container = DataGridContainer(win)
+    controller = DataGridController(datagrid_container, data_source)
+    datagrid_container.grid_vbox.reparent(win)
+
+    win.show()
+
+
+For more advanced usages see the example applications in the "examples" folder.
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
-# wheel==0.23.0
+wheel>=0.23.0
 python-dateutil>=2.4.2
 sqlalchemy>=0.9
 Pillow>=2.7.0
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 SETUP_DIR = os.path.dirname(os.path.realpath(__file__))
 EGG_RE = re.compile('#egg=([^#@\n]+)')
 
-readme = open(os.path.join(SETUP_DIR, 'README.rst')).read()
+readme = open(os.path.join(SETUP_DIR, 'DESCRIPTION.rst')).read()
 history = open(
     os.path.join(
         SETUP_DIR, 'HISTORY.rst')).read().replace('.. :changelog:', '')
@@ -72,6 +72,7 @@ def recurse_data_files(path):
 setup(
     name='datagrid_gtk3',
     version='0.1.2',
+    license='MIT',
     description='MVC framework for working with the GTK3 TreeView widget.',
     long_description=readme + '\n\n' + history,
     author='NowSecure',