Skip to content

Commit ee46c86

Browse files
committed
Add requirements, and instruction for demo project, version bump
1 parent 91e1919 commit ee46c86

File tree

4 files changed

+44
-17
lines changed

4 files changed

+44
-17
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [1.0.2] - 2023-08-31
6+
- Add a demo project for exploration and also containing all documentation code for proofing.
7+
- Revise and Enhancing Tutorial , Group by and Time series documentation.
8+
- Fix issue with error on dev console on report page due to resources duplication
9+
- Fix issue with Custom querysets not being correctly connected in the view
10+
- Fix issue with time series custom dates
11+
- Fix issue with Crosstab on traversing fields
12+
513

614
## [1.0.1] - 2023-07-03
715

README.rst

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -194,16 +194,38 @@ You can interact with the `ReportGenerator` using same syntax as used with the `
194194
my_report.get_report_data() # -> [{'title':'Product 1', '__total__: 56}, {'title':'Product 2', '__total__: 43}, ]
195195
196196
197-
This is just a scratch, for more please visit the documentation
197+
This is just a scratch of what you can do and customize.
198+
199+
Demo site
200+
---------
201+
202+
Available on `Django Slick Reporting <https://django-slick-reporting.com/>`_
203+
204+
205+
You can also use locally
206+
207+
.. code-block:: console
208+
209+
# clone the repo
210+
# create a virtual environment, activate it, then
211+
cd django-slick-reporting/demo_proj
212+
pip install requirements.txt
213+
python manage.py migrate
214+
python manage.py create_entries
215+
python manage.py runserver
216+
217+
the ``create_entries`` command will generate data for the demo app
218+
198219

199220
Batteries Included
200221
------------------
201222

202223
Slick Reporting comes with
203224

204-
* A Bootstrap Filter Form
205-
* Charting support `Chart.js <https://www.chartjs.org/>`_
206-
* Powerful tables `datatables.net <https://datatables.net/>`_
225+
* An auto-generated, bootstrap-ready Filter Form
226+
* Carts.js Charting support `Chart.js <https://www.chartjs.org/>`_
227+
* Highcharts.js Charting support `Highcharts.js <https://www.highcharts.com//>`_
228+
* Datatables `datatables.net <https://datatables.net/>`_
207229

208230
A Preview:
209231

@@ -212,11 +234,6 @@ A Preview:
212234
:alt: Shipped in View Page
213235

214236

215-
Demo site
216-
---------
217-
218-
Available on `Django Slick Reporting <https://django-slick-reporting.com/>`_
219-
220237
Documentation
221238
-------------
222239

@@ -225,11 +242,8 @@ Available on `Read The Docs <https://django-slick-reporting.readthedocs.io/en/la
225242
Road Ahead
226243
----------
227244

228-
This project is young and can use your support.
229-
230-
Some of the ideas / features that ought be added
231-
232-
* Support Other backends like SQL Alchemy & Pandas
245+
* Continue on enriching the demo project
246+
* Add the dashboard capabilities
233247

234248

235249
Running tests
@@ -268,6 +282,6 @@ If you like this package, chances are you may like those packages too!
268282

269283
`Django Tabular Permissions <https://github.com/RamezIssac/django-tabular-permissions>`_ Display Django permissions in a HTML table that is translatable and easy customized.
270284

271-
`Django Ra ERP Framework <https://github.com/ra-systems/RA>`_ A framework to build business solutions with ease.
285+
`Django ERP Framework <https://github.com/ra-systems/RA>`_ A framework to build business solutions with ease.
272286

273287
If you find this project useful or promising , You can support us by a github ⭐

demo_proj/requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
django>=4.2
2+
python-dateutil>=2.8.1
3+
simplejson
4+
django-crispy-forms
5+
crispy-bootstrap4

slick_reporting/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
default_app_config = "slick_reporting.apps.ReportAppConfig"
22

3-
VERSION = (1, 0, 1)
3+
VERSION = (1, 0, 2)
44

5-
__version__ = "1.0.1"
5+
__version__ = "1.0.2"

0 commit comments

Comments
 (0)