| Name | djpress JSON |
| Version |
0.15.1
JSON |
| download |
| home_page | None |
| Summary | A blog application for Django sites, inspired by classic WordPress. |
| upload_time | 2024-12-17 01:26:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Stuart Maxwell Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
blog
cms
django
markdown
wordpress
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DJ Press
A blog application for Django sites, inspired by classic WordPress.
> Warning - very alpha.
## Goals
Why build another blog engine? These are my goals...
- Simple to get started with sensible defaults: install plugin, configure `urls.py`, and migrate.
- Follows Django patterns: configuration in `settings.py`, content management in the Django admin.
- Configurable to suit a wide variety of use-cases: lots of configuration available, but not required.
- Customisable with themes: themes can be written using only template tags, no knowledge of models required.
- Customisable with plugins: simple plugins are easy to write, but complex plugins are possible.
- Powerful but lightweight: provide core functionality, allow plugins to fill gaps and enhance.
## Versioning
This package uses semantic versioning, but until we reach version 1.x.x, the following rules will apply:
- MAJOR version will remain on 0 until the base functionality is complete.
- MINOR version indicates that an incompatible or breaking change has been introduced.
- PATCH version indicates a bug fix or a backward compatible change.
If you choose to use this package prior to version 1.x being release, please pin your requirements to a specific minor version, e.g. `djpress~=0.11.0`
## Installation
- Install `djpress` by adding it to your requirements file, e.g. `djpress~=0.11.0` (see versioning note, above).
- Add it to your `INSTALLED_APPS` in Django:
```python
INSTALLED_APPS = [
# ...
"djpress.apps.DjpressConfig",
# ...
]
```
- Add the URLs to your project's main `urls.py` file.
The following will set DJ Press to be available at the root of your site, e.g. `https://example.com/`
```python
from django.urls import path, include
urlpatterns = [
# ...
path("", include("djpress.urls")),
# ...
]
```
If you want your blog to be in a subdirectory, use something like the following:
```python
from django.urls import path, include
urlpatterns = [
# ...
path("blog/", include("djpress.urls")),
# ...
]
```
- Run migrations: `python3 manage.py migrate`
> Note that this relies on the Django Admin for content management, so ensure that you have a user with at least `staff` status to manage content.
## Configuration
In your settings.py file, create a `DJPRESS_SETTINGS` dictionary. Here are some common settings:
```python
# DJPress settings
DJPRESS_SETTINGS = {
"SITE_TITLE": "My Awesome Blog",
"POST_PREFIX": "{{ year }}/{{ month }}", # blog post URLs are prefixed with "year/month": /2024/10/blog-post-slug/
}
```
There are lots more settings available. Please check [the docs](https://stuartmaxwell.github.io/djpress) or look at the source code:
[src/djpress/app_settings.py](https://github.com/stuartmaxwell/djpress/blob/main/src/djpress/app_settings.py)
## Documentation
Documentation is a work-in-progress, but is available on GitHub Pages: <https://stuartmaxwell.github.io/djpress>
## Badges
[](https://codecov.io/github/stuartmaxwell/djpress)
Raw data
{
"_id": null,
"home_page": null,
"name": "djpress",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "blog, cms, django, markdown, wordpress",
"author": null,
"author_email": "Stuart Maxwell <stuart@amanzi.nz>",
"download_url": "https://files.pythonhosted.org/packages/f9/43/dfcd1d039bc73d9ede3be611ac38a973436edd4eb7a30971b82c4916d243/djpress-0.15.1.tar.gz",
"platform": null,
"description": "# DJ Press\n\nA blog application for Django sites, inspired by classic WordPress.\n\n> Warning - very alpha.\n\n## Goals\n\nWhy build another blog engine? These are my goals...\n\n- Simple to get started with sensible defaults: install plugin, configure `urls.py`, and migrate.\n- Follows Django patterns: configuration in `settings.py`, content management in the Django admin.\n- Configurable to suit a wide variety of use-cases: lots of configuration available, but not required.\n- Customisable with themes: themes can be written using only template tags, no knowledge of models required.\n- Customisable with plugins: simple plugins are easy to write, but complex plugins are possible.\n- Powerful but lightweight: provide core functionality, allow plugins to fill gaps and enhance.\n\n## Versioning\n\nThis package uses semantic versioning, but until we reach version 1.x.x, the following rules will apply:\n\n- MAJOR version will remain on 0 until the base functionality is complete.\n- MINOR version indicates that an incompatible or breaking change has been introduced.\n- PATCH version indicates a bug fix or a backward compatible change.\n\nIf you choose to use this package prior to version 1.x being release, please pin your requirements to a specific minor version, e.g. `djpress~=0.11.0`\n\n## Installation\n\n- Install `djpress` by adding it to your requirements file, e.g. `djpress~=0.11.0` (see versioning note, above).\n- Add it to your `INSTALLED_APPS` in Django:\n\n```python\nINSTALLED_APPS = [\n # ...\n \"djpress.apps.DjpressConfig\",\n # ...\n]\n```\n\n- Add the URLs to your project's main `urls.py` file.\n\nThe following will set DJ Press to be available at the root of your site, e.g. `https://example.com/`\n\n```python\nfrom django.urls import path, include\n\nurlpatterns = [\n # ...\n path(\"\", include(\"djpress.urls\")),\n # ...\n]\n```\n\nIf you want your blog to be in a subdirectory, use something like the following:\n\n```python\nfrom django.urls import path, include\n\nurlpatterns = [\n # ...\n path(\"blog/\", include(\"djpress.urls\")),\n # ...\n]\n```\n\n- Run migrations: `python3 manage.py migrate`\n\n> Note that this relies on the Django Admin for content management, so ensure that you have a user with at least `staff` status to manage content.\n\n## Configuration\n\nIn your settings.py file, create a `DJPRESS_SETTINGS` dictionary. Here are some common settings:\n\n```python\n# DJPress settings\nDJPRESS_SETTINGS = {\n \"SITE_TITLE\": \"My Awesome Blog\",\n \"POST_PREFIX\": \"{{ year }}/{{ month }}\", # blog post URLs are prefixed with \"year/month\": /2024/10/blog-post-slug/\n}\n```\n\nThere are lots more settings available. Please check [the docs](https://stuartmaxwell.github.io/djpress) or look at the source code:\n[src/djpress/app_settings.py](https://github.com/stuartmaxwell/djpress/blob/main/src/djpress/app_settings.py)\n\n## Documentation\n\nDocumentation is a work-in-progress, but is available on GitHub Pages: <https://stuartmaxwell.github.io/djpress>\n\n## Badges\n\n[](https://codecov.io/github/stuartmaxwell/djpress)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Stuart Maxwell Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A blog application for Django sites, inspired by classic WordPress.",
"version": "0.15.1",
"project_urls": {
"Documentation": "https://stuartmaxwell.github.io/djpress/",
"Homepage": "https://github.com/stuartmaxwell/djpress",
"Issues": "https://github.com/stuartmaxwell/djpress/issues",
"Repository": "https://github.com/stuartmaxwell/djpress"
},
"split_keywords": [
"blog",
" cms",
" django",
" markdown",
" wordpress"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be8a9eee7171509b54c52c962bd97561125293c7b2530278f23ffc3a3337a7f6",
"md5": "0f514482f0deec05ee02e131cad8c1a0",
"sha256": "707687a5161364cc1542b1be2f98a1042525a76183431345a6b64c63450faa0d"
},
"downloads": -1,
"filename": "djpress-0.15.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f514482f0deec05ee02e131cad8c1a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 49774,
"upload_time": "2024-12-17T01:25:57",
"upload_time_iso_8601": "2024-12-17T01:25:57.948265Z",
"url": "https://files.pythonhosted.org/packages/be/8a/9eee7171509b54c52c962bd97561125293c7b2530278f23ffc3a3337a7f6/djpress-0.15.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f943dfcd1d039bc73d9ede3be611ac38a973436edd4eb7a30971b82c4916d243",
"md5": "37f872d19cfee80e7505625b2432c311",
"sha256": "97cfa9278e79780f2d5de6217588dda7d2f593ad00bb2a54636d0fc822f07412"
},
"downloads": -1,
"filename": "djpress-0.15.1.tar.gz",
"has_sig": false,
"md5_digest": "37f872d19cfee80e7505625b2432c311",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 128440,
"upload_time": "2024-12-17T01:26:00",
"upload_time_iso_8601": "2024-12-17T01:26:00.771496Z",
"url": "https://files.pythonhosted.org/packages/f9/43/dfcd1d039bc73d9ede3be611ac38a973436edd4eb7a30971b82c4916d243/djpress-0.15.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 01:26:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stuartmaxwell",
"github_project": "djpress",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "djpress"
}
