Skip to main content

a Django announcements app

Project description

# Pinax Announcements

[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/) [![](https://img.shields.io/travis/pinax/pinax-announcements.svg)](https://travis-ci.org/pinax/pinax-announcements) [![](https://img.shields.io/coveralls/pinax/pinax-announcements.svg)](https://coveralls.io/r/pinax/pinax-announcements) [![](https://img.shields.io/pypi/dm/pinax-announcements.svg)](https://pypi.python.org/pypi/pinax-announcements/) [![](https://img.shields.io/pypi/v/pinax-announcements.svg)](https://pypi.python.org/pypi/pinax-announcements/) [![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-announcements/)

## Pinax

[Pinax](http://pinaxproject.com/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](https://github.com/pinax/pinax-announcements/blob/master/docs/index.md).

## Contribute

See [this blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/) including a video, or our [How to Contribute](http://pinaxproject.com/pinax/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](http://pinaxproject.com/pinax/ways_to_contribute/) section.

In case of any questions we recommend you [join our Pinax Slack team](http://slack.pinaxproject.com) 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](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).

## 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pinax-announcements-2.0.4.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

pinax_announcements-2.0.4-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pinax-announcements-2.0.4.tar.gz.

File metadata

File hashes

Hashes for pinax-announcements-2.0.4.tar.gz
Algorithm Hash digest
SHA256 3d5361a0fb88020230a4ae76a5f60e524f09a26fe53bf20871bd6129e2446d47
MD5 638d4b14e5e701f26e54c7761a53248c
BLAKE2b-256 a107c091a2753785eb4533541b3e9f9a3843665b1c65d20ff3dd91561f659bd9

See more details on using hashes here.

File details

Details for the file pinax_announcements-2.0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pinax_announcements-2.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3c49084fb097f53e9f2ffbc6ec229cc65d35ef34c98f94896220d6d1e1dfbe69
MD5 91b3f7ef5b9156d2b559d6ddc96d85a3
BLAKE2b-256 c9c74cdeb5ee7c4d3c3276e8b5856edeb452133101f7bf41a44a68d0fd7b1c9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page