https://github.com/ramezissac/django-erp-framework
A Django based framework to create diverse business solutions, equipped with a reporting engine with charts, widgets system , a custom admin site and other goodies
https://github.com/ramezissac/django-erp-framework
charting django erp framework python reporting-engine responsive-design
Last synced: 6 months ago
JSON representation
A Django based framework to create diverse business solutions, equipped with a reporting engine with charts, widgets system , a custom admin site and other goodies
- Host: GitHub
- URL: https://github.com/ramezissac/django-erp-framework
- Owner: RamezIssac
- License: agpl-3.0
- Created: 2019-12-08T20:00:37.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-16T20:49:03.000Z (over 1 year ago)
- Last Synced: 2025-03-28T09:08:40.633Z (6 months ago)
- Topics: charting, django, erp, framework, python, reporting-engine, responsive-design
- Language: Python
- Homepage:
- Size: 17.1 MB
- Stars: 350
- Watchers: 13
- Forks: 92
- Open Issues: 13
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://img.shields.io/pypi/v/django-erp-framework.svg
:target: https://pypi.org/project/django-erp-framework
.. image:: https://img.shields.io/pypi/pyversions/django-erp-framework.svg
:target: https://pypi.org/project/django-erp-framework
.. image:: https://img.shields.io/readthedocs/django-erp-framework
:target: https://django-erp-framework.readthedocs.io/
.. image:: https://img.shields.io/codecov/c/github/ra-systems/django-erp-framework
:target: https://codecov.io/gh/ra-systems/django-erp-framework
Django ERP Framework
====================
A light-weight, effective, Django based framework to create various business applications, resource planing and management systems.
Offers a ready made platform where you can start to create data entry pages and attach various reports to them.
Features
--------
* A Reporting Engine that can generate grouped reports and/or time series and/or crosstab from any model in your apps.
* Charting capabilities to represent the data in the reports.
* Widget system to create dashboards and display bits of the reports results and/or its charts on any page you want.
* Customizable and easily extensible.
* Django Jazzmin admin theme integration ready to use.
* Python 3.8 / 3.9 / 3.10 , Django 3.2 +
Installation
------------
.. code-block:: console
$ pip install django-erp-framework
OR
$ pip install -e git+https://github.com/RamezIssac/django-erp-framework.git#egg=django-erp-framework@develop
Check out the `getting started `_ on Read The Docs.
Demo
----
You can checkout a demo application `here `_.
Code is available on `Github `_.
.. image:: https://github.com/RamezIssac/django-erp-framework/blob/develop/docs/source/_static/widgets.png?raw=true
:alt: Homepage
:align: center
Documentation
-------------
Available on `Read The Docs `_
Please Proceed to the tutorial `Create a sales application Part 1 `_
Reporting Engine
----------------
The reporting engine of this framework is released as a separate package `django-slick-reporting `_.
Testing and contribution
------------------------
To run the test suite, first, create and activate a virtual environment. Then
clone the repo, install the test requirements and run the tests::
# 1. Clone and install requirements
$ git clone git+git@github.com:ra-systems/django-erp-framework.git
$ cd tests
$ pip install -e ..
$ pip install -r requirements.txt
# 2. Set the test database connection details in the environment
$ export DATABASE_NAME=
$ export DATABASE_USER=
$ export DATABASE_PASSWORD=
# 3. Run the tests
$ ./runtests.py
# And for Coverage report
$ coverage run --include=../* runtests.py [-k]
$ coverage html
For more information on contributing, we honor `Django's guidelines `_.