Name | djp JSON |
Version |
0.3.1
JSON |
| download |
home_page | None |
Summary | A plugin system for Django |
upload_time | 2024-09-26 16:28:18 |
maintainer | None |
docs_url | None |
author | Simon Willison |
requires_python | >=3.8 |
license | Apache-2.0 |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# DJP: Django Plugins
[![PyPI](https://img.shields.io/pypi/v/djp.svg)](https://pypi.org/project/djp/)
[![Tests](https://github.com/simonw/djp/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/djp/actions/workflows/test.yml)
[![Changelog](https://img.shields.io/github/v/release/simonw/djp?include_prereleases&label=changelog)](https://github.com/simonw/djp/releases)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/djp/blob/main/LICENSE)
A plugin system for Django
Visit **[djp.readthedocs.io](https://djp.readthedocs.io/)** for full documentation, including how to install plugins and how to write new plugins.
See [DJP: A plugin system for Django](https://simonwillison.net/2024/Sep/25/djp-a-plugin-system-for-django/) for an introduction to this project.
## Installation
Install this library using `pip`:
```bash
pip install djp
```
## Configuration
Add this to the **end** of your `settings.py` file:
```python
import djp
# ... existing settings.py contents
djp.settings(globals())
```
Then add this to your URL configuration in `urls.py`:
```python
urlpatterns = [
# ...
] + djp.urlpatterns()
```
## Usage
Installing a plugin in the same environment as your Django application should cause that plugin to automatically add the necessary
## Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd djp
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
python -m pip install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "djp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Simon Willison",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/83/58/95fdfa5c5d9b7c64a96599b9f5fbfa34c254c28961ddd93491cf4e550b22/djp-0.3.1.tar.gz",
"platform": null,
"description": "# DJP: Django Plugins\n\n[![PyPI](https://img.shields.io/pypi/v/djp.svg)](https://pypi.org/project/djp/)\n[![Tests](https://github.com/simonw/djp/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/djp/actions/workflows/test.yml)\n[![Changelog](https://img.shields.io/github/v/release/simonw/djp?include_prereleases&label=changelog)](https://github.com/simonw/djp/releases)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/djp/blob/main/LICENSE)\n\nA plugin system for Django\n\nVisit **[djp.readthedocs.io](https://djp.readthedocs.io/)** for full documentation, including how to install plugins and how to write new plugins.\n\nSee [DJP: A plugin system for Django](https://simonwillison.net/2024/Sep/25/djp-a-plugin-system-for-django/) for an introduction to this project.\n\n## Installation\n\nInstall this library using `pip`:\n```bash\npip install djp\n```\n\n## Configuration\n\nAdd this to the **end** of your `settings.py` file:\n```python\nimport djp\n\n# ... existing settings.py contents\n\ndjp.settings(globals())\n```\nThen add this to your URL configuration in `urls.py`:\n```python\nurlpatterns = [\n # ...\n] + djp.urlpatterns()\n```\n\n## Usage\n\nInstalling a plugin in the same environment as your Django application should cause that plugin to automatically add the necessary \n\n## Development\n\nTo contribute to this library, first checkout the code. Then create a new virtual environment:\n```bash\ncd djp\npython -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\npython -m pip install -e '.[test]'\n```\nTo run the tests:\n```bash\npython -m pytest\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A plugin system for Django",
"version": "0.3.1",
"project_urls": {
"CI": "https://github.com/simonw/djp/actions",
"Changelog": "https://github.com/simonw/djp/releases",
"Homepage": "https://github.com/simonw/djp",
"Issues": "https://github.com/simonw/djp/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60730dc7d0c372ed366ecb8b7dd760525c90f53e0e2f40f8e944cd810d017a4a",
"md5": "8668b64ffffe27af9cdb53ffacaff577",
"sha256": "dd2490907d503fef0f1a729d00268fbcb7c11c77b33b9a46b6d13cc7cb5dc389"
},
"downloads": -1,
"filename": "djp-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8668b64ffffe27af9cdb53ffacaff577",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8813,
"upload_time": "2024-09-26T16:28:17",
"upload_time_iso_8601": "2024-09-26T16:28:17.335137Z",
"url": "https://files.pythonhosted.org/packages/60/73/0dc7d0c372ed366ecb8b7dd760525c90f53e0e2f40f8e944cd810d017a4a/djp-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "835895fdfa5c5d9b7c64a96599b9f5fbfa34c254c28961ddd93491cf4e550b22",
"md5": "32ccd9f6db389be1f8ff19d407b52e0f",
"sha256": "7d447c2f42282ec7628567e4ece5090ef37095b87e0853ebe8f0b876a1143e83"
},
"downloads": -1,
"filename": "djp-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "32ccd9f6db389be1f8ff19d407b52e0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8668,
"upload_time": "2024-09-26T16:28:18",
"upload_time_iso_8601": "2024-09-26T16:28:18.899959Z",
"url": "https://files.pythonhosted.org/packages/83/58/95fdfa5c5d9b7c64a96599b9f5fbfa34c254c28961ddd93491cf4e550b22/djp-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 16:28:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "djp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "djp"
}