- About Pinax
- Important Links
- Overview
- Documentation
- Change Log
- History
- Contribute
- Code of Conduct
- Connect with Pinax
- License
Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.
Where you can find what you need:
- Releases: published to PyPI or tagged in app repos in the Pinax GitHub organization
- Global documentation: Pinax documentation website
- App specific documentation: app repos in the Pinax GitHub organization
- Support information: SUPPORT.md file in the Pinax default community health file repo
- Contributing information: CONTRIBUTING.md file in the Pinax default community health file repo
- Current and historical release docs: Pinax Wiki
pinax-blog is a blog app for Django.
Current features include:
- support for multiple channels (e.g. technical vs business)
- use of Creole (optional) and Markdown as markup format
- Atom and RSS feeds
- previewing of blog posts before publishing
- optional ability to announce new posts on twitter
- Traditional date based urls or simpler slug-only urls, via configuration
- Control over opengraph and twitter card meta data per post
- Review comments per post for multi-author workflows
- public but secret urls for unpublished blog posts for easier review
- django-appconf
- pytz
- pillow
- markdown
- pygments
- pinax-images
See setup.py for specific required versions of these packages.
| Django / Python | 3.6 | 3.7 | 3.8 |
|---|---|---|---|
| 2.2 | * | * | * |
| 3.0 | * | * | * |
To install pinax-blog:
$ pip install pinax-blogAdd pinax.blog and dependency pinax.images to your INSTALLED_APPS setting:
INSTALLED_APPS = [
# other apps
"pinax.blog",
"pinax.images",
]Add pinax.blog.urls to your project urlpatterns:
urlpatterns = [
# other urls
url(r"^blog/", include("pinax.blog.urls", namespace="pinax_blog")),
]pinax-blog ships with a few management view templates. These templates reference pinax-images
URLs for adding and viewing images. They also use "bootstrap" formatting.
In order to use these built-in templates, add django-bootstrap-form to your project requirements
and "bootstrapform", to your INSTALLED_APPS:
INSTALLED_APPS = [
# other apps
"pinax.blog",
"pinax.images",
"bootstrapform",
]Then add pinax.images.urls to your project urlpatterns:
urlpatterns = [
# other urls
url(r"^blog/", include("pinax.blog.urls", namespace="pinax_blog")),
url(r"^ajax/images/", include("pinax.images.urls", namespace="pinax_images")),
]If you want creole support for mark-up:
$ pip install creoleNOTE: the creole package does not support Python 3.
As an author, you work with this app via the Django Admin.
You can customize the editor for the admin at the site level or just use the stock text areas.
The description field in the admin represents the text that will be used in
different HTML META header tags that are useful for controlling the display
on social networks like Twitter and Facebook.
This is the same idea behind the primary_image field in the admin.
There are custom markdown and creole extensions for embedding images that
have been uploaded via the inline on the post create or edit form in the admin.
You first upload the image or images you want to use in the post by selecting
them in the file selector in the images section, and then hitting "Save and
Continue Editing". Once the form reloads, you'll see indicators above each
uploaded image with a number between two brackets, e.g. {{ 25 }}.
This is the syntax if you are using creole for adding that image to your
post. You can just copy and paste that.
If you are using markdown however, you will need to use the following
markup in your post:
or without alt text:
Adjusting for the number of the image, of course.
String in the format "app.Model" that will set a ForeignKey on the blog.Post model
URL variable name used in your url prefix that will allow you to look up your scoping object
A hookset pattern common to other Pinax apps. Just a single method: get_blog(self, **kwargs) is defined.
Override this in your project to the Blog object that will scope your posts.
By default there is only one Blog instance and that is returned.
The idea of scoping allows you to setup your project to have multiple blogs partitioned by whatever domain object you would like.
Add pinax.blog.context_processors.scoped to your context processors to put scoper_lookup in templates for url reversing.
To demonstrate how to set all this up let's walk through an example where we
will scope by auth.User so that each user has their own blog at /users/:username/.
First we will modify the settings.py:
# ... abbreviated for clarity
TEMPLATES = [
{
# ...
"OPTIONS": {
# ...
"context_processors": [
# ...
"pinax.blog.context_processors.scoped"
],
},
},
]
PINAX_BLOG_SCOPING_URL_VAR = "username"
PINAX_BLOG_SCOPING_MODEL = "auth.User"
PINAX_BLOG_HOOKSET = "multiblog.hooks.HookSet" # where `multiblog` is the package name of our projectNow, we'll add the url in urls.py:
url(r"^users/(?P<username>[-\w]+)/", include("pinax.blog.urls", namespace="pinax_blog"))And finally we'll implement our hookset by adding a hooks.py:
from django.contrib.auth.models import User
class HookSet(object):
def get_blog(self, **kwargs):
username = kwargs.get("username", None)
return User.objects.get(username=username).blogThis is designed to work out of the box with templates in pinax-theme-bootstrap
so you can either use them directly or use them as a reference. If you need to
reverse a URL for any of the pinax-blog urls you can simply do:
{% url "pinax_blog:blog" scoper_lookup %}Customizing the admin functionality can be as complex as overriding the ModelAdmin
and ModelForm that ships with pinax-blog or as simple as just overriding
the admin/blog/post/change_form.html template.
Here is an example of an actual customization to use the ACE Editor for teaser and body content:
{% extends "admin/change_form.html" %}
{% load i18n admin_urls %}
{% block extrahead %}
{{ block.super }}
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/ace/1.1.8/ace.js"></script>
<script>
$(function () {
var contentDiv = $("<div>").attr("id", "content-editor"),
teaserDiv = $("<div>").attr("id", "teaser-editor"),
setupEditor = function (editor, textarea) {
editor.setTheme("ace/theme/twilight");
editor.getSession().setMode("ace/mode/markdown");
editor.getSession().setValue(textarea.val());
editor.getSession().setUseWrapMode(true);
editor.getSession().on('change', function(){
textarea.val(editor.getSession().getValue());
});
editor.getSession().setTabSize(4);
editor.getSession().setUseSoftTabs(true);
};
$(".field-content div").append(contentDiv);
$(".field-teaser div").append(teaserDiv);
var editor1 = ace.edit("content-editor");
var editor2 = ace.edit("teaser-editor");
var textarea1 = $('textarea[name="content"]').hide();
var textarea2 = $('textarea[name="teaser"]').hide();
setupEditor(editor1, textarea1);
setupEditor(editor2, textarea2);
});
</script>
<style type="text/css" media="screen">
#content-editor {
min-height: 300px;
width: 80%;
min-width: 800px;
}
#teaser-editor {
min-height: 100px;
width: 80%;
min-width: 800px;
}
</style>
{% endblock %}Default templates are provided by the pinax-templates app in the
blog
section of that project.
Reference pinax-templates installation instructions to include these templates in your project.
View live pinax-templates examples and source at Pinax Templates!
Override the default pinax-templates templates by copying them into your project
subdirectory pinax/blog/ on the template path and modifying as needed.
For example if your project doesn't use Bootstrap, copy the desired templates
then remove Bootstrap and Font Awesome class names from your copies.
Remove class references like class="btn btn-success" and class="icon icon-pencil" as well as
bootstrap from the {% load i18n bootstrap %} statement.
Since bootstrap template tags and filters are no longer loaded, you'll also need to update
{{ form|bootstrap }} to {{ form }} since the "bootstrap" filter is no longer available.
BlogIndexView and SectionIndexView both render the template
pinax/blog/blog_list.html with post_list, search_query, current_section
context variables, where current_section is either a Section object or the
string "all".
The post_list variable is a queryset of current blog posts. If the GET parameter,
q is found, it filters the queryset create a simple search mechanism, then
assigns the value to search_query.
The four blog detail views (DateBasedPostDetailView, SecretKeyPostDetailView,
SlugUniquePostDetailView, and StaffPostDetailView) all render the template
pinax/blog/blog_post.html with the post and current_section context
variables.
The post is the requested post. It may or may not be public depending on the
url requested.
The url blog_feed will either render pinax/blog/atom_feed.xml or
pinax/blog/rss_feed.xml depending on the parameters in the URL. It will pass
both templates the context variables of feed_id, feed_title, blog_url,
feed_url, feed_updated, entries, and current_site.
Both templates ship already configured to work out of the box.
- Change
from django.utils.functional import currytofrom functools import partial as curry
- Drop Django 1.11, 2.0, and 2.1, and Python 2,7, 3.4, and 3.5 support
- Add Django 2.2 and 3.0, and Python 3.6, 3.7, and 3.8 support
- Update packaging configs
- Direct users to community resources
- Enable installation of both .html and .xml template files via egg
- Reenable imagesets to be inline in the post creation
- Fix Markdown 3 installation exception by changing to 2.6.11 which is the latest working version
- Fix migration missing on_delete=
- Restore and improve documentation guidance for pinax-images usage
- Replace pinax-theme-bootstrap test dependency with pinax-templates
- Add Django 2.0 compatibility testing
- Drop Django 1.8, 1.9, 1.10 and Python 3.3 support
- Move documentation into README, and standardize layout
- Convert CI and coverage to CircleCi and CodeCov
- Add PyPi-compatible long description
- Bump minimum required version of pinax-images to v3.0.0 for Django 2.0 compatibility
- Bump minimum required version of pinax-images
- Add image support in admin
- Make the js inclusions a setting
- remove inadvertently included IDE file
- Add Django 2.0 compatibility testing
- Drop Django 1.9 and Python 3.3 support
- Move documentation into README
- Convert CI and coverage to CircleCi and CodeCov
- Add PyPi-compatible long description
scopedcontext processor handles case whenrequest.resolver_matchis None
- increased max_length of Post.slug field from 50 to 90 chars, matching Post.title field length.
- fix templatetag scoping
- added support for frontend editing
- removed twitter integrations
- swapped out internal image management for pinax-images
- added a
Blogscoping model and enabled site defined one to one relationship custom site-defined scoping.
- Initial version for core distribution
This app was named biblion when originally developed by Eldarion, Inc.
After donation to Pinax, the app was renamed to pinax-blog, making it easier
to find and know what it is.
Contributing information can be found in the Pinax community health file repo.
In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a Code of Conduct. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
For updates and news regarding the Pinax Project, please follow us on Twitter @pinaxproject and check out our Pinax Project blog.
Copyright (c) 2012-present James Tauber and contributors under the MIT license.