Allows custom event sending of login failures/success to TCell
Project description
By [TCell](https://www.tcell.io/).
TCell Hooks is to be used in conjuction with the [tcell_agent](https://pypi.python.org/pypi/tcell_agent) to allow for custom event notifications of login failures and login successes.
## Getting started
You can add it to your requirements.txt file with:
```python
tcell_hooks==1.0.0
```
Then run `pip install -r requirements.txt`
There are two options for calling the hooks from your application code:
By providing a Django/Flask request object and having the TCell Agent extract the relevant details from it:
```python
from tcell_hooks.v1 import send_django_login_event, LOGIN_SUCCESS
send_django_login_event(
status=LOGIN_SUCCESS,
django_request=request,
user_id="tcell@tcell.io",
session_id="124KDJFL3234"
)
```
```python
from tcell_hooks.v1 import send_flask_login_event, LOGIN_SUCCESS
send_flask_login_event(
status=LOGIN_SUCCESS,
flask_request=request,
user_id="tcell@tcell.io",
session_id="124KDJFL3234"
)
```
Or by providing each individual piece of information required for the TCell event:
```python
from tcell_hooks.v1 import send_login_event, LOGIN_SUCCESS
send_login_event(
status=LOGIN_SUCCESS,
session_id="124KDJFL3234",
user_agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) ...",
referrer="http://192.168.99.100:3000/",
remote_address="192.168.99.1",
header_keys=["HOST", "USER_AGENT", "ACCEPT", "REFERER", "ACCEPT_ENCODING", "ACCEPT_LANGUAGE", "COOKIE"],
user_id="tcell@tcell.io",
document_uri="/users/auth/doorkeeper/callbackuri"
)
```
The available statuses are:
`LOGIN_SUCCESS`
`LOGIN_FAILURE`
## Important Note
If the [tcell_agent](https://pypi.python.org/pypi/tcell_agent) is not installed or if it's disabled, this code will do nothing and should have no performance effect on your app.
TCell Hooks is to be used in conjuction with the [tcell_agent](https://pypi.python.org/pypi/tcell_agent) to allow for custom event notifications of login failures and login successes.
## Getting started
You can add it to your requirements.txt file with:
```python
tcell_hooks==1.0.0
```
Then run `pip install -r requirements.txt`
There are two options for calling the hooks from your application code:
By providing a Django/Flask request object and having the TCell Agent extract the relevant details from it:
```python
from tcell_hooks.v1 import send_django_login_event, LOGIN_SUCCESS
send_django_login_event(
status=LOGIN_SUCCESS,
django_request=request,
user_id="tcell@tcell.io",
session_id="124KDJFL3234"
)
```
```python
from tcell_hooks.v1 import send_flask_login_event, LOGIN_SUCCESS
send_flask_login_event(
status=LOGIN_SUCCESS,
flask_request=request,
user_id="tcell@tcell.io",
session_id="124KDJFL3234"
)
```
Or by providing each individual piece of information required for the TCell event:
```python
from tcell_hooks.v1 import send_login_event, LOGIN_SUCCESS
send_login_event(
status=LOGIN_SUCCESS,
session_id="124KDJFL3234",
user_agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) ...",
referrer="http://192.168.99.100:3000/",
remote_address="192.168.99.1",
header_keys=["HOST", "USER_AGENT", "ACCEPT", "REFERER", "ACCEPT_ENCODING", "ACCEPT_LANGUAGE", "COOKIE"],
user_id="tcell@tcell.io",
document_uri="/users/auth/doorkeeper/callbackuri"
)
```
The available statuses are:
`LOGIN_SUCCESS`
`LOGIN_FAILURE`
## Important Note
If the [tcell_agent](https://pypi.python.org/pypi/tcell_agent) is not installed or if it's disabled, this code will do nothing and should have no performance effect on your app.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tcell_hooks-1.0.0.tar.gz
(2.5 kB
view details)
File details
Details for the file tcell_hooks-1.0.0.tar.gz
.
File metadata
- Download URL: tcell_hooks-1.0.0.tar.gz
- Upload date:
- Size: 2.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c06df33885719aaf7ecf49dd296895721a0a775e944affd22a718682502a41cf |
|
MD5 | 530b87fc6f97ada5fcd4509bff8326a2 |
|
BLAKE2b-256 | 1ad563a38e5665978eaa3d8f4ace1adda65333c9c63ad5a285586a98fb9e5c42 |