Skip to content
a Django app for allowing users of your site to send messages to each other
Python Other
Find file
Latest commit 6d9d4de @ossanna16 ossanna16 Update README.rst

README.rst

Pinax Messages

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 collection can be found at http://pinaxproject.com.

pinax-messages

pinax-messages is an application for allowing users of your Django site to send messages to each other.

This was formerly named user-messages but was renamed after being donated to Pinax from Eldarion.

Getting Started

Include pinax-messages in your requirements file and add "pinax.messages" to your INSTALLED APPS setting.

Once you have the pinax-messages installed, hook up the URLs:

urlpatterns = patterns("",
    # some cool URLs

    (r"^messages/", include("pinax.messages.urls")),

    # some other cool URLs
)

Now all you need to do is wire up some templates.

Running the Tests

$ pip install detox
$ detox

Documentation

The pinax-messages documentation is currently under construction. If you would like to help us write documentation, please join our Slack channel and let us know! The Pinax documentation is available at http://pinaxproject.com/pinax/.

Contribute

See 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 would recommend for you to 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 would also highly recommend for your to read our Open Source and Self-Care blog pos ](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'd like to 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.

Something went wrong with that request. Please try again.