a site-wide announcement reusable app for Django
Python Makefile
Pull request Compare This branch is 146 commits ahead, 3 commits behind brosner:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
pinax
.coveragerc
.gitignore
.travis.yml
AUTHORS
CONTRIBUTING.md
LICENSE
MANIFEST.in
Makefile
Makefile.txt
README.md
makemigrations.py
mkdocs.yml
runtests.py
setup.cfg
setup.py
tox.ini

README.md

Pinax Announcements

Pinax

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 app is part of the Pinax ecosystem and is designed for use both with and independently of other Pinax apps.

pinax-announcements

pinax-announcements is a well tested, documented, and proven solution for any site wanting announcements for it's users.

Announcements have title and content, with options for filtering their display:

  • site_wide - True or False
  • members_only - True or False
  • publish_start - date/time or none
  • publish_end - date/time or none

pinax-announcements has three options for dismissing an announcement:

  • DISMISSAL_NO - always visible
  • DISMISSAL_SESSION - dismiss for the session
  • DISMISSAL_PERMANENT - dismiss forever

Getting Started and Documentation

Follow steps outlined in Pinax Announcements Documentation.

Contribute

See this blog post including a video, or our How to Contribute section for an overview on how contributing to Pinax works. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With section.

In case of any questions we recommend you join our Pinax Slack team and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course also valid but we are usually able to help you faster if you ping us in Slack.

We also highly recommend reading our Open Source and Self-Care blog post.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found here http://pinaxproject.com/pinax/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.

Pinax Project Blog and Twitter

For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our blog http://blog.pinaxproject.com.