Artur Barseghyan avatar Artur Barseghyan committed 47c8f27 Draft

better docs

Comments (0)

Files changed (3)

 sirep Package
-=============
+===================================
 Simple report generation. Can be used to generate any kind of CSV or HTML reports. Instead of binding the complicated
 joins in class it expects a queryset to be provided along with headers (which are basically the text values for the
 first row of the HTML table or CSV file). Further, it requires the redefinition of the ``process_data`` which
 If you want to have the date filtering set, you should provide the following attribute as well:
     * ``date_field`` (example: date_field = 'date_published')
 
-
 Installation
---------------------
+===================================
 1. Latest stable version on PyPI:
 
     $ pip install sirep
 local_settings and visit the "http://localhost:8000/sirep/" URL.
 
 Example app
---------------------
+===================================
 If you want to have a working example of the app, check the example directory of the source and follow the
 installation instructions described in `example/readme.rst`.
 
     https://bitbucket.org/barseghyanartur/sirep/src
 
+An automated installer resides in `sirep_install_example.sh`. Download it somewhere, activate your virtual
+environement and run the installer. You will soon be able to see the example report
+http://127.0.0.1:8000/sirep/foo-report/.
+
 Sample report screenshoots:
 
 .. image:: _static/sirep_report.png
     :align: center
 
 Usage examples
---------------------
+===================================
 Sample model module (file `test_package/models.py`):
 
     >>> class TestModel(models.Model):
 
 
 Indices and tables
-==================
+===================================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
 
+License
+===================================
+GPL 2.0/LGPL 2.1
+
+Support
+===================================
+For any issues contact me at the e-mail given in the `Author` section.
+
+Author
+===================================
+Artur Barseghyan <artur.barseghyan@gmail.com>
-===============
-sirep
-===============
-
-Description
------------------
+sirep Package
+===================================
 Simple report generation. Can be used to generate any kind of CSV or HTML reports. Instead of binding the complicated
 joins in class it expects a queryset to be provided along with headers (which are basically the text values for the
 first row of the HTML table or CSV file). Further, it requires the redefinition of the ``process_data`` which
 If you want to have the date filtering set, you should provide the following attribute as well:
     * ``date_field`` (example: date_field = 'date_published')
 
-License
------------------
-GPL 2.0/LGPL 2.1
-
 Installation
---------------------
+===================================
 1. Latest stable version on PyPI:
 
     $ pip install sirep
 
-Or, eventually, the latest development version
-
-    $ pip install -e hg+https://bitbucket.org/barseghyanartur/sirep#egg=sirep
-
 2. Add 'sirep' to your ``INSTALLED_APPS``:
 
     >>> INSTALLED_APPS = (
 sirep.reports example). In order to see the demo, set the ``SIREP_SHOW_ADMIN_TEST_MODEL_DEMO`` to True in your
 local_settings and visit the "http://localhost:8000/sirep/" URL.
 
-Usage examples
---------------------
-It might be just as easy to check the source code (example directory), since it works out of the box (to get
-an idea of what it is):
+Example app
+===================================
+If you want to have a working example of the app, check the example directory of the source and follow the
+installation instructions described in `example/readme.rst`.
 
     https://bitbucket.org/barseghyanartur/sirep/src
 
+An automated installer resides in `sirep_install_example.sh`. Download it somewhere, activate your virtual
+environement and run the installer. You will soon be able to see the example report
+http://127.0.0.1:8000/sirep/foo-report/.
+
+Sample report screenshoots:
+
+.. image:: _static/sirep_report.png
+    :width: 960px
+    :align: center
+
+.. image:: _static/sirep_report_filtered.png
+    :width: 960px
+    :align: center
+
+Usage examples
+===================================
 Sample model module (file `test_package/models.py`):
 
     >>> class TestModel(models.Model):
 That's all. You may now navigate to your report `http://127.0.0.1:8000/sirep/test-report/`. Note that `test-report`
 is the slug using which we have registered the report (`sirep.register`).
 
+License
+===================================
+GPL 2.0/LGPL 2.1
+
+Support
+===================================
+For any issues contact me at the e-mail given in the `Author` section.
+
 Author
------------------
-Artur Barseghyan <artur.barseghyan@gmail.com>
+===================================
+Artur Barseghyan <artur.barseghyan@gmail.com>
Add a comment to this file

sirep_install_example.sh

File contents unchanged.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.