Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtlpy/django-slackin-public
Slack invitation page for Django
https://github.com/mtlpy/django-slackin-public
django-framework slack
Last synced: 3 months ago
JSON representation
Slack invitation page for Django
- Host: GitHub
- URL: https://github.com/mtlpy/django-slackin-public
- Owner: mtlpy
- License: mit
- Fork: true (brilliantorg/django-slackin)
- Created: 2018-02-13T03:19:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T17:44:28.000Z (almost 7 years ago)
- Last Synced: 2024-09-19T11:42:45.525Z (4 months ago)
- Topics: django-framework, slack
- Language: Python
- Homepage: https://pypi.python.org/pypi/django-slackin-public
- Size: 68.4 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-slackin-public
[](https://pypi.python.org/pypi/django-slackin-public)
[](https://pypi.python.org/pypi/django-slackin-public)
[](https://pypi.python.org/pypi/django-slackin-public)
[](https://travis-ci.org/mtlpy/django-slackin-public)
Slack invitation page for Django (like https://github.com/rauchg/slackin)
## Installation & setup
Install django-slackin-public
```bash
# pip install django-slackin-public
```
Add to your `INSTALLED_APPS`
```python
INSTALLED_APPS = (
...
'django_slackin_public',
)
```
Include the django-slackin-public URLconf in your project urls.py like this
```python
url(r'^slackin/', include('django_slackin_public.urls')),
```
Update your settings.py
```python
SLACKIN_TOKEN = 'YOUR-SLACK-TOKEN' # create a token at https://api.slack.com/web
SLACKIN_SUBDOMAIN = 'your-team' # if https://your-team.slack.com
```
Visit [http://localhost:8000/slackin/](http://localhost:8000/slackin/) to send an invite to your Slack team.
## Using signals
Use signals to listen for invite events. Available signals are:
- email_address_already_invited
- email_address_already_in_team
- sent_invite_to_email_address
To listen for a signal:
```python
from slackin.signals import sent_invite_to_email_address
@receiver(sent_invite_to_email_address)
def my_invite_handler(sender, email_address):
print 'SIGNAL RECEIVED: {}'.format(email_address)
```
## Custom templates
To use custom templates, add the either of following files to your app's template directory
depending on what you want to customize.
See [templates/slackin](https://github.com/mtlpy/django-slackin-public/tree/master/django_slackin_public/templates/slackin)
for more details.
- `slackin/invite/page.html`: the surrounding `body`, `head`, and inlined styles
- `slackin/invite/content.html`: the text and form
Templates have access to the following slackin-specific context variables:
- `slackin.team_name`: slack team name
- `slackin.team_image`: slack team image
- `slackin.users_online`: number of team members currently online
- `slackin.users_total`: total number of team members
- `slackin_invite_form`: invite form object
- `slackin_invite_form_success`: `True` if `slackin_invite_form.is_valid()`
# Development
## Using [Dad](https://github.com/pior/dad)
```shell
$ dad clone mtlpy/django-slackin-public
...
$ dad up
...
$ dad lint
...
```
## Release
- Change the version in `setup.py`
- Commit with message like `Release vX.X.X`
- Run `dad upload-release`