<div align="center">
<h1>Django Lookbook</h1>
<p>Empower your Django development with this pluggable app for creating a robust component library. Includes preview system, documentation engine, and parameter editor for building modular UI effortlessly.</p>
<p><strong><a href="https://django-lookbook.readthedocs.io/en/latest/">Documentation</a> | <a href="https://saashammer.com/lookbook/">Demo site</a></strong></p>
<p><a href="https://pypi.org/project/django-lookbook/"><img src="https://badge.fury.io/py/django-lookbook.svg" alt="Pypi version"></a>
<a href="https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml"><img src="https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml/badge.svg" alt="CI status"></a></p>
</div>
## Features
- Auto-detect and render the previews
- Filter previews in real-time
- Draggable and resizable layout
- Auto extract documentation from the preview doc string
- Powerful parameter editor, which allows the user to check UI in real-time (for example: change button text and color)
- This app is **pluggable** and can be integrated with any Django project
## Techs
This project is a reusable Django app that uses the following technologies:
1. [Tailwind CSS](https://tailwindcss.com/)
2. [Stimulus JS](https://stimulus.hotwire.dev/)
## Storybook Controls
> Storybook Controls gives you a graphical UI to interact with a component's arguments dynamically without needing to code. It creates an addon panel next to your component examples ("stories"), so you can edit them live.
django-lookbook provides simple way to let developer use classic Django form to add `Params Editor` to the preview, which allow user to interact with the preview in real-time.
## Special Thanks
This project is heavily inspired by [lookbook](https://github.com/lookbook-hq/lookbook) from the Rails community.
Raw data
{
"_id": null,
"home_page": "https://github.com/rails-inspire-django/django-lookbook",
"name": "django-lookbook",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Michael Yin",
"author_email": "michaelyin@accordbox.com",
"download_url": "https://files.pythonhosted.org/packages/35/5b/918068ebee1bae38438571908a5311b5da0b2cb1593342963fc2b12e3b1d/django_lookbook-1.0.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<h1>Django Lookbook</h1>\n\n<p>Empower your Django development with this pluggable app for creating a robust component library. Includes preview system, documentation engine, and parameter editor for building modular UI effortlessly.</p>\n\n<p><strong><a href=\"https://django-lookbook.readthedocs.io/en/latest/\">Documentation</a> | <a href=\"https://saashammer.com/lookbook/\">Demo site</a></strong></p>\n\n<p><a href=\"https://pypi.org/project/django-lookbook/\"><img src=\"https://badge.fury.io/py/django-lookbook.svg\" alt=\"Pypi version\"></a>\n<a href=\"https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml\"><img src=\"https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml/badge.svg\" alt=\"CI status\"></a></p>\n\n</div>\n\n\n\n## Features\n\n- Auto-detect and render the previews\n- Filter previews in real-time\n- Draggable and resizable layout\n- Auto extract documentation from the preview doc string\n- Powerful parameter editor, which allows the user to check UI in real-time (for example: change button text and color)\n- This app is **pluggable** and can be integrated with any Django project\n\n## Techs\n\nThis project is a reusable Django app that uses the following technologies:\n\n1. [Tailwind CSS](https://tailwindcss.com/)\n2. [Stimulus JS](https://stimulus.hotwire.dev/)\n\n## Storybook Controls\n\n> Storybook Controls gives you a graphical UI to interact with a component's arguments dynamically without needing to code. It creates an addon panel next to your component examples (\"stories\"), so you can edit them live.\n\ndjango-lookbook provides simple way to let developer use classic Django form to add `Params Editor` to the preview, which allow user to interact with the preview in real-time.\n\n\n\n## Special Thanks\n\nThis project is heavily inspired by [lookbook](https://github.com/lookbook-hq/lookbook) from the Rails community.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "UI development environment for Django",
"version": "1.0.2",
"project_urls": {
"Changelog": "https://github.com/rails-inspire-django/django-lookbook/releases",
"Homepage": "https://github.com/rails-inspire-django/django-lookbook"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1889ada3b333bc6ea8d3ac02eda1664de29d4f7d89bf87ebfb7129bee0c50349",
"md5": "0f418493157b3825b778ee3f0874650d",
"sha256": "af8228ceca9c93ae287d447f70923988bb4c4cc9758d371fe22fc95fa42efd10"
},
"downloads": -1,
"filename": "django_lookbook-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f418493157b3825b778ee3f0874650d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1645556,
"upload_time": "2024-06-06T06:15:29",
"upload_time_iso_8601": "2024-06-06T06:15:29.191510Z",
"url": "https://files.pythonhosted.org/packages/18/89/ada3b333bc6ea8d3ac02eda1664de29d4f7d89bf87ebfb7129bee0c50349/django_lookbook-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "355b918068ebee1bae38438571908a5311b5da0b2cb1593342963fc2b12e3b1d",
"md5": "fddcd448b27df95dc748e2b177f7e6a5",
"sha256": "3305b1c458e2a79e82626ded556e9bbdce31825112789473c316aabcdccd3ebb"
},
"downloads": -1,
"filename": "django_lookbook-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fddcd448b27df95dc748e2b177f7e6a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1628936,
"upload_time": "2024-06-06T06:15:30",
"upload_time_iso_8601": "2024-06-06T06:15:30.994739Z",
"url": "https://files.pythonhosted.org/packages/35/5b/918068ebee1bae38438571908a5311b5da0b2cb1593342963fc2b12e3b1d/django_lookbook-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 06:15:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rails-inspire-django",
"github_project": "django-lookbook",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-lookbook"
}
JSON
