https://github.com/divio/djangocms-articles
Please do not use, this is experimental
https://github.com/divio/djangocms-articles
Last synced: over 1 year ago
JSON representation
Please do not use, this is experimental
- Host: GitHub
- URL: https://github.com/divio/djangocms-articles
- Owner: divio
- License: other
- Created: 2019-02-20T16:35:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-21T11:56:18.000Z (over 7 years ago)
- Last Synced: 2025-01-20T09:46:42.219Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
===================
django CMS Articles
===================
|pypi| |build| |coverage|
**django CMS Articles** adds article function to `django CMS `_.
It is aimed to display common article information like news, blog entries, events
and further types. It is extendable to add your own custom structure.
This addon is compatible with `Divio Cloud `_ and is also available on the
`django CMS Marketplace `_
for easy installation.
Contributing
============
This is a an open-source project. We'll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review our `contribution guidelines
`_.
We're grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the `contributors `_
section.
One of the easiest contributions you can make is helping to translate this addon on
`Transifex `_.
Documentation
=============
See ``REQUIREMENTS`` in the `setup.py `_
file for additional dependencies:
|python| |django| |djangocms|
* Django Filer 1.2.4 or higher
Make sure `django Filer `_
is installed and configured appropriately.
Installation
------------
For a manual install:
* run ``pip install djangocms-articles``
* add ``djangocms_articles`` to your ``INSTALLED_APPS``
* run ``python manage.py migrate djangocms_articles``
Configuration
-------------
TBA
Running Tests
-------------
You can run tests by executing::
virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test
.. |pypi| image:: https://badge.fury.io/py/djangocms-articles.svg
:target: http://badge.fury.io/py/djangocms-articles
.. |build| image:: https://travis-ci.org/divio/djangocms-articles.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-articles
.. |coverage| image:: https://codecov.io/gh/divio/djangocms-articles/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-articles
.. |python| image:: https://img.shields.io/badge/python-2.7%20%7C%203.4+-blue.svg
:target: https://pypi.org/project/djangocms-articles/
.. |django| image:: https://img.shields.io/badge/django-1.11%20%7C%202.0%20%7C%202.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.4%2B-blue.svg
:target: https://www.django-cms.org/