aa-secret-santa


Nameaa-secret-santa JSON
Version 0.3.0a0 PyPI version JSON
download
home_page
SummaryAlliance Auth Secret Santa
upload_time2023-12-11 11:50:01
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords allianceauth eveonline
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AA Secret Santa

A Secret Santa Manager for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth)

## Features

- Accepts Applications to be secret santas
- Handles randomly pairing up users
- Notifies users of their santee
- handles if gifts have been delivered
- [Secure Groups Integration](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups)

## Installation

### Step 1 - Install app

```shell
pip install aa-secret-santa
```

### Step 2 - Configure Auth settings

Configure your Auth settings (`local.py`) as follows:

- Add `'secretsanta'` to `INSTALLED_APPS`

### Step 4 - Maintain Alliance Auth

- Run migrations `python manage.py migrate`
- Gather your staticfiles `python manage.py collectstatic`
- Restart your project `supervisorctl restart myauth:`

### Step 5 - Configuration

In the Admin interface, visit `secretsanta` or `<AUTH-URL>/admin/secretsanta` # Coming Soon

## Permissions

| Perm | Admin Site  | Perm | Description |
| --- | --- | --- | --- |
| basic_access | nill | Can access Secret Santa | Can access the Secret Santa Module and Apply to Years
| manager | nill | Can manage Secret Santa | Can Manage and See all Santa<>Santee Pairs

## Settings

| Name | Description | Default |
| --- | --- | --- |
`SECRETSANTA_GENERATE_PAIRS_PRIORITY`| the generate_pairs task, to run super uber omega immediately so we can identify issues | 1
`SECRETSANTA_NOTIFY_PRIORITY`| Priority for discord messages for secret santa | 5

## Contributing

Make sure you have signed the [License Agreement](https://developers.eveonline.com/resource/license-agreement) by logging in at <https://developers.eveonline.com> before submitting any pull requests. All bug fixes or features must not include extra superfluous formatting changes.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "aa-secret-santa",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "allianceauth,eveonline",
    "author": "",
    "author_email": "Joel Falknau <joel.falknau@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/7b/0feca45d216dd102037b651fcb5a5603317f1c63d0bee761c2e29a90ced9/aa_secret_santa-0.3.0a0.tar.gz",
    "platform": null,
    "description": "# AA Secret Santa\n\nA Secret Santa Manager for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth)\n\n## Features\n\n- Accepts Applications to be secret santas\n- Handles randomly pairing up users\n- Notifies users of their santee\n- handles if gifts have been delivered\n- [Secure Groups Integration](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups)\n\n## Installation\n\n### Step 1 - Install app\n\n```shell\npip install aa-secret-santa\n```\n\n### Step 2 - Configure Auth settings\n\nConfigure your Auth settings (`local.py`) as follows:\n\n- Add `'secretsanta'` to `INSTALLED_APPS`\n\n### Step 4 - Maintain Alliance Auth\n\n- Run migrations `python manage.py migrate`\n- Gather your staticfiles `python manage.py collectstatic`\n- Restart your project `supervisorctl restart myauth:`\n\n### Step 5 - Configuration\n\nIn the Admin interface, visit `secretsanta` or `<AUTH-URL>/admin/secretsanta` # Coming Soon\n\n## Permissions\n\n| Perm | Admin Site  | Perm | Description |\n| --- | --- | --- | --- |\n| basic_access | nill | Can access Secret Santa | Can access the Secret Santa Module and Apply to Years\n| manager | nill | Can manage Secret Santa | Can Manage and See all Santa<>Santee Pairs\n\n## Settings\n\n| Name | Description | Default |\n| --- | --- | --- |\n`SECRETSANTA_GENERATE_PAIRS_PRIORITY`| the generate_pairs task, to run super uber omega immediately so we can identify issues | 1\n`SECRETSANTA_NOTIFY_PRIORITY`| Priority for discord messages for secret santa | 5\n\n## Contributing\n\nMake sure you have signed the [License Agreement](https://developers.eveonline.com/resource/license-agreement) by logging in at <https://developers.eveonline.com> before submitting any pull requests. All bug fixes or features must not include extra superfluous formatting changes.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Alliance Auth Secret Santa",
    "version": "0.3.0a0",
    "project_urls": {
        "Homepage": "https://gitlab.com/tactical-supremacy/aa-secret-santa",
        "Source": "https://gitlab.com/tactical-supremacy/aa-secret-santa",
        "Tracker": "https://gitlab.com/tactical-supremacy/aa-secret-santa/-/issues"
    },
    "split_keywords": [
        "allianceauth",
        "eveonline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f74c70abddafacd6ebb6a40f6be4af0fc0f55b5b1189c7e452e9fe62c8b39bef",
                "md5": "b86869134f0cb311d411ccf169d65b1f",
                "sha256": "614f5b92282ca9da1c380ccf98f990c5431d34cdb93ad91087be1e07e57f118b"
            },
            "downloads": -1,
            "filename": "aa_secret_santa-0.3.0a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b86869134f0cb311d411ccf169d65b1f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 18267,
            "upload_time": "2023-12-11T11:49:59",
            "upload_time_iso_8601": "2023-12-11T11:49:59.027632Z",
            "url": "https://files.pythonhosted.org/packages/f7/4c/70abddafacd6ebb6a40f6be4af0fc0f55b5b1189c7e452e9fe62c8b39bef/aa_secret_santa-0.3.0a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c7b0feca45d216dd102037b651fcb5a5603317f1c63d0bee761c2e29a90ced9",
                "md5": "262b815c63915ab7342113d0d427ed71",
                "sha256": "50459037b8569a7415427a88574005f2f43299ee6a3e92c10fc38b309007d8e4"
            },
            "downloads": -1,
            "filename": "aa_secret_santa-0.3.0a0.tar.gz",
            "has_sig": false,
            "md5_digest": "262b815c63915ab7342113d0d427ed71",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11941,
            "upload_time": "2023-12-11T11:50:01",
            "upload_time_iso_8601": "2023-12-11T11:50:01.229173Z",
            "url": "https://files.pythonhosted.org/packages/6c/7b/0feca45d216dd102037b651fcb5a5603317f1c63d0bee761c2e29a90ced9/aa_secret_santa-0.3.0a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-11 11:50:01",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "tactical-supremacy",
    "gitlab_project": "aa-secret-santa",
    "lcname": "aa-secret-santa"
}
        
Elapsed time: 0.22386s