collective.blog

Blog features for Plone

[![PyPI](https://img.shields.io/pypi/v/collective.blog)](https://pypi.org/project/collective.blog/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/collective.blog)](https://pypi.org/project/collective.blog/) [![PyPI - Wheel](https://img.shields.io/pypi/wheel/collective.blog)](https://pypi.org/project/collective.blog/) [![PyPI - License](https://img.shields.io/pypi/l/collective.blog)](https://pypi.org/project/collective.blog/) [![PyPI - Status](https://img.shields.io/pypi/status/collective.blog)](https://pypi.org/project/collective.blog/) [![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/collective.blog)](https://pypi.org/project/collective.blog/) [![Meta](https://github.com/collective/collective.blog/actions/workflows/meta.yml/badge.svg)](https://github.com/collective/collective.blog/actions/workflows/meta.yml) ![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000) [![GitHub contributors](https://img.shields.io/github/contributors/collective/collective.blog)](https://github.com/collective/collective.blog) [![GitHub Repo stars](https://img.shields.io/github/stars/collective/collective.blog?style=social)](https://github.com/collective/collective.blog)

Features

collective.blog adds blogging features to a Plone site.

Content Types

name	context
`Blog`	A folderish content type that supports adding Posts and Authors
`Blog Author`	An Author in a blog
`Blog Tag`	A Tag for categorizing posts in a blog
`Blog Post`	A Post in a blog

Installation

Add collective.blog as a dependency on your package's setup.py

    install_requires = [
        "collective.blog",
        "Plone",
        "plone.restapi",
        "setuptools",
    ],

Also, add collective.blog to your package's configure.zcml (or dependencies.zcml):

<include package="collective.blog" />

Generic Setup

To automatically enable this package when your add-on is installed, add the following line inside the package's profiles/default/metadata.xml dependencies element:

    <dependency>profile-collective.blog:default</dependency>

Source Code and Contributions

We welcome contributions to collective.blog.

You can create an issue in the issue tracker, or contact a maintainer.

Development requirements

Python 3.8 or later
Docker

Setup

Install all development dependencies -- including Plone -- and create a new instance using:

make install

Update translations

make i18n

Format codebase

make format

Run tests

Testing of this package is done with pytest and tox.

Run all tests with:

make test

Run all tests but stop on the first error and open a pdb session:

./bin/tox -e test -- -x --pdb

Run only tests that match TestVocabAuthors:

./bin/tox -e test -- -k TestVocabAuthors

Run only tests that match TestVocabAuthors, but stop on the first error and open a pdb session:

./bin/tox -e test -- -k TestVocabAuthors -x --pdb

Credits

The development of this add-on has been kindly sponsored by German Aerospace Center (DLR) and Forschungszentrum Jülich.

Developed by kitconcept

License

The project is licensed under GPLv2.

collective / collective.blog

readme