| Name | djing JSON |
| Version |
0.9.4
JSON |
| download |
| home_page | None |
| Summary | djing admin panel |
| upload_time | 2025-01-03 11:01:54 |
| maintainer | None |
| docs_url | None |
| author | Krunal Dodiya |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
---
description: Django Admin Panel inspired by Laravel Nova.
---
# Introduction
[](https://djing.gitbook.io/docs)
Djing is a powerful and elegant Django admin panel inspired by Laravel Nova. It brings the flexibility, functionality, and modern aesthetics of Laravel Nova to Django developers, making it a breeze to manage your Django projects. With support for actions, filters, metrics, lenses, and custom components, Djing aims to simplify and enhance your administrative workflows.
---
## Features
- **Actions**: Perform bulk operations on resources with ease.
- **Filters**: Customize the data displayed in your views using advanced filters.
- **Metrics & Cards**: Gain insights into your data with dynamic, customizable metrics and cards.
- **Lenses**: Create focused views to analyze specific subsets of your data.
- **Resources**: Manage your models and resources effortlessly.
- **Custom Fields**: Add personalized fields to meet your application's unique needs.
- **Custom Cards**: Extend the interface with custom-designed cards.
- **Beautiful UI**: Enjoy a clean, modern, and responsive user interface.
---
## Screenshots
Below is an example of the Djing admin panel interface:
<table>
<tr>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/login.png" alt="Djing Admin - Login" width="300"/>
<p align="center">Login</p>
</td>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resources.png" alt="Djing Admin - Resources" width="300"/>
<p align="center">Resources</p>
</td>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resource-detail.png" alt="Djing Admin - Resource Detail" width="300"/>
<p align="center">Resource Detail</p>
</td>
</tr>
<tr>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/create-resource.png" alt="Djing Admin - Create Resource" width="300"/>
<p align="center">Create Resource</p>
</td>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/update-resource.png" alt="Djing Admin - Update Resource" width="300"/>
<p align="center">Update Resource</p>
</td>
<td>
<img src="https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resource-metrics.png" alt="Djing Admin - Update Resource" width="300"/>
<p align="center">Resource Metrics</p>
</td>
</tr>
</table>
_The above screenshot showcases the clean and modern UI of the Djing admin panel._
---
## Installation
To install Djing, use pip:
```bash
pip install djing
```
Add `djing` to your `INSTALLED_APPS` in your Django project:
```python
INSTALLED_APPS = [
...,
'djing',
]
```
Make sure to set the `STATIC_ROOT` & `STATIC_URL` in your `settings.py` file before collecting static files:
```python
STATIC_URL = "/static/"
STATIC_ROOT = BASE_DIR / "static"
STATIC_DIRS = [
MEDIA_ROOT,
]
```
after then you can collect static files
```python
python manage.py collectstatic
```
Optionally, when uploading files / images, you need to add STORAGES, MEDIA_ROOT & MEDIA_URL in your settings.py.
```python
STORAGES = {
"default": {
"BACKEND": "django.core.files.storage.FileSystemStorage",
"OPTIONS": {
"location": BASE_DIR / "media", # Replace with your media directory path
},
},
"staticfiles": {
"BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
},
}
MEDIA_URL = "/media/"
MEDIA_ROOT = BASE_DIR / "media"
```
After adding djing application to settings.py, you can now access djing CLI using, it provides a set of commands to help you work efficiently:
```bash
commander list
```
above command will list all available CLI commands for djing application:
```bash
PyJinx Framework 0.2.4
Usage:
Commands [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-v, --version Display this application version
Available Commands:
list List all commands
djing
djing:install Install assets
djing:resource Create a new resource class
djing:dashboard Create a new dashboard class
djing:action Create a new action class
djing:filter Create a new filter class
djing:lens Create a new lens class
djing:value Create a new metric (single value) class
djing:progress Create a new metric (progress) class
djing:partition Create a new metric (partition) class
djing:table Create a new metric (table) class
djing:field Create a new custom field
djing:card Create a new custom card
djing:rule Create a new validation rule
djing:policy Create a new authorization policy
```
Finally, you need to install djing application using installation command:
```bash
python manage.py djing:install
```
Ensure that the `django_project_name` is set in the `.env` file. If not specified, it defaults to `myproject`:
```env
DJANGO_PROJECT_NAME=<your-project-name>
DJING_LICENSE_KEY=<your-license-key>
```
## Customization
Djing is highly extensible. You can create your own cards, fields, and components to match your project's specific requirements. Refer to the documentation for details on creating custom components.
## Documentation
Comprehensive documentation is available at [Djing Documentation](https://djing.gitbook.io/docs) to help you get started and explore advanced features.
## Contribution
Contributions are welcome! Please fork the repository and submit a pull request with your improvements. For major changes, open an issue to discuss your ideas first.
## License
Djing is open-source software licensed under the [MIT license](LICENSE/) **only for development purposes**.
For production use, a valid license key is required. To obtain a production license, visit the [Djing Licensing Page](https://djing.vercel.app/licenses).
## Support
For questions, issues, or feature requests, please create an issue on the [GitHub repository](https://github.com/djing-admin/djing).
## Author
- **Krunal Dodiya**
- Email: [kunal.dodiya1@gmail.com](mailto:kunal.dodiya1@gmail.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "djing",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Krunal Dodiya",
"author_email": "kunal.dodiya1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c7/23/f367539ec96534987bd93e553f3a0d4f7517463837ec2c1b137918e3321b/djing-0.9.4.tar.gz",
"platform": null,
"description": "---\ndescription: Django Admin Panel inspired by Laravel Nova.\n---\n\n# Introduction\n\n[](https://djing.gitbook.io/docs)\n\nDjing is a powerful and elegant Django admin panel inspired by Laravel Nova. It brings the flexibility, functionality, and modern aesthetics of Laravel Nova to Django developers, making it a breeze to manage your Django projects. With support for actions, filters, metrics, lenses, and custom components, Djing aims to simplify and enhance your administrative workflows.\n\n---\n\n## Features\n\n- **Actions**: Perform bulk operations on resources with ease.\n- **Filters**: Customize the data displayed in your views using advanced filters.\n- **Metrics & Cards**: Gain insights into your data with dynamic, customizable metrics and cards.\n- **Lenses**: Create focused views to analyze specific subsets of your data.\n- **Resources**: Manage your models and resources effortlessly.\n- **Custom Fields**: Add personalized fields to meet your application's unique needs.\n- **Custom Cards**: Extend the interface with custom-designed cards.\n- **Beautiful UI**: Enjoy a clean, modern, and responsive user interface.\n\n---\n\n## Screenshots\n\nBelow is an example of the Djing admin panel interface:\n\n<table>\n <tr>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/login.png\" alt=\"Djing Admin - Login\" width=\"300\"/>\n <p align=\"center\">Login</p>\n </td>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resources.png\" alt=\"Djing Admin - Resources\" width=\"300\"/>\n <p align=\"center\">Resources</p>\n </td>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resource-detail.png\" alt=\"Djing Admin - Resource Detail\" width=\"300\"/>\n <p align=\"center\">Resource Detail</p>\n </td>\n </tr>\n <tr>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/create-resource.png\" alt=\"Djing Admin - Create Resource\" width=\"300\"/>\n <p align=\"center\">Create Resource</p>\n </td>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/update-resource.png\" alt=\"Djing Admin - Update Resource\" width=\"300\"/>\n <p align=\"center\">Update Resource</p>\n </td>\n <td>\n <img src=\"https://raw.githubusercontent.com/djing-admin/djing/refs/heads/main/screenshots/resource-metrics.png\" alt=\"Djing Admin - Update Resource\" width=\"300\"/>\n <p align=\"center\">Resource Metrics</p>\n </td>\n </tr>\n</table>\n\n_The above screenshot showcases the clean and modern UI of the Djing admin panel._\n\n---\n\n## Installation\n\nTo install Djing, use pip:\n\n```bash\npip install djing\n```\n\nAdd `djing` to your `INSTALLED_APPS` in your Django project:\n\n```python\nINSTALLED_APPS = [\n ...,\n 'djing',\n]\n```\n\nMake sure to set the `STATIC_ROOT` & `STATIC_URL` in your `settings.py` file before collecting static files:\n\n```python\nSTATIC_URL = \"/static/\"\nSTATIC_ROOT = BASE_DIR / \"static\"\nSTATIC_DIRS = [\n MEDIA_ROOT,\n]\n```\n\nafter then you can collect static files\n\n```python\npython manage.py collectstatic\n```\n\nOptionally, when uploading files / images, you need to add STORAGES, MEDIA_ROOT & MEDIA_URL in your settings.py.\n\n```python\nSTORAGES = {\n \"default\": {\n \"BACKEND\": \"django.core.files.storage.FileSystemStorage\",\n \"OPTIONS\": {\n \"location\": BASE_DIR / \"media\", # Replace with your media directory path\n },\n },\n \"staticfiles\": {\n \"BACKEND\": \"whitenoise.storage.CompressedManifestStaticFilesStorage\",\n },\n}\n\nMEDIA_URL = \"/media/\"\nMEDIA_ROOT = BASE_DIR / \"media\"\n```\n\nAfter adding djing application to settings.py, you can now access djing CLI using, it provides a set of commands to help you work efficiently:\n\n```bash\ncommander list\n```\n\nabove command will list all available CLI commands for djing application:\n\n```bash\nPyJinx Framework 0.2.4\n\nUsage:\n Commands [options] [arguments]\n\nOptions:\n -h, --help Display help for the given command. When no command is given display help for the list command\n -q, --quiet Do not output any message\n -v, --version Display this application version\n\nAvailable Commands:\n list List all commands\n djing\n djing:install Install assets\n djing:resource Create a new resource class\n djing:dashboard Create a new dashboard class\n djing:action Create a new action class\n djing:filter Create a new filter class\n djing:lens Create a new lens class\n djing:value Create a new metric (single value) class\n djing:progress Create a new metric (progress) class\n djing:partition Create a new metric (partition) class\n djing:table Create a new metric (table) class\n djing:field Create a new custom field\n djing:card Create a new custom card\n djing:rule Create a new validation rule\n djing:policy Create a new authorization policy\n```\n\nFinally, you need to install djing application using installation command:\n\n```bash\npython manage.py djing:install\n```\n\nEnsure that the `django_project_name` is set in the `.env` file. If not specified, it defaults to `myproject`:\n\n```env\nDJANGO_PROJECT_NAME=<your-project-name>\nDJING_LICENSE_KEY=<your-license-key>\n```\n\n## Customization\n\nDjing is highly extensible. You can create your own cards, fields, and components to match your project's specific requirements. Refer to the documentation for details on creating custom components.\n\n## Documentation\n\nComprehensive documentation is available at [Djing Documentation](https://djing.gitbook.io/docs) to help you get started and explore advanced features.\n\n## Contribution\n\nContributions are welcome! Please fork the repository and submit a pull request with your improvements. For major changes, open an issue to discuss your ideas first.\n\n## License\n\nDjing is open-source software licensed under the [MIT license](LICENSE/) **only for development purposes**.\n\nFor production use, a valid license key is required. To obtain a production license, visit the [Djing Licensing Page](https://djing.vercel.app/licenses).\n\n## Support\n\nFor questions, issues, or feature requests, please create an issue on the [GitHub repository](https://github.com/djing-admin/djing).\n\n## Author\n\n- **Krunal Dodiya**\n- Email: [kunal.dodiya1@gmail.com](mailto:kunal.dodiya1@gmail.com)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "djing admin panel",
"version": "0.9.4",
"project_urls": {
"documentation": "https://djing.gitbook.io/docs",
"homepage": "https://djing.vercel.app",
"repository": "https://github.com/djing-admin/djing"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "269d952bd11dce18bb0f06d2f080fb498921a542dec4f0490783116002335496",
"md5": "f4b4289f82f5654f3f3a5d4a4d49aa3f",
"sha256": "13fdb816d4cb7fc229e9e9e0409f082c008cc26ffaaa7eb48e121094bdceccd7"
},
"downloads": -1,
"filename": "djing-0.9.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4b4289f82f5654f3f3a5d4a4d49aa3f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 1109683,
"upload_time": "2025-01-03T11:01:50",
"upload_time_iso_8601": "2025-01-03T11:01:50.295776Z",
"url": "https://files.pythonhosted.org/packages/26/9d/952bd11dce18bb0f06d2f080fb498921a542dec4f0490783116002335496/djing-0.9.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c723f367539ec96534987bd93e553f3a0d4f7517463837ec2c1b137918e3321b",
"md5": "543d01a4eb8b934c345b694f9b2c78a1",
"sha256": "a48b84548184075e7d8a7be396977f18a1901b36c7785606f61798961c1fc33b"
},
"downloads": -1,
"filename": "djing-0.9.4.tar.gz",
"has_sig": false,
"md5_digest": "543d01a4eb8b934c345b694f9b2c78a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 1008680,
"upload_time": "2025-01-03T11:01:54",
"upload_time_iso_8601": "2025-01-03T11:01:54.318538Z",
"url": "https://files.pythonhosted.org/packages/c7/23/f367539ec96534987bd93e553f3a0d4f7517463837ec2c1b137918e3321b/djing-0.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 11:01:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "djing-admin",
"github_project": "djing",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "djing"
}
