| Name | aa-alumni JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Integration with Alliance Auths State System, creates and maintains an Alumni State for past members of an Alliance and/or Corporation |
| upload_time | 2024-12-04 13:13:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
allianceauth
eveonline
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Alliance Auth - Alumni
## Features
- Integration with Alliance Auth's State System, creates and maintains an Alumni State for past members of an Alliance and/or Corporation.
## Installation
### Step 1 - Prepare Auth
Remove/Promote any state with a priority of `1`, Alumni is considered slightly better than the built in Guest State.
### Step 2 - Install from pip
```shell
pip install aa-alumni
```
### Step 3 - Configure Auth settings
Configure your Auth settings (`local.py`) as follows:
- Add `'alumni'` to `INSTALLED_APPS`
- Add below lines to your settings file:
```python
## Settings for AA-Alumni
# Tasks
CELERYBEAT_SCHEDULE['alumni_run_alumni_check_all'] = {
'task': 'alumni.tasks.run_alumni_check_all',
'schedule': crontab(minute=37, hour=3, day_of_week=4),
}
CELERYBEAT_SCHEDULE['alumni_run_update_all_models'] = {
'task': 'alumni.tasks.update_all_models',
'schedule': crontab(minute=37, hour=3, day_of_week=3),
}
```
### Step 4 - Update AA's State system
```shell
python myauth/manage.py alumni_state
```
### Step 5 - Maintain Alliance Auth
- Run migrations `python manage.py migrate`
- Gather your staticfiles `python manage.py collectstatic`
- Restart your project `supervisorctl restart myauth:`
### Step 6 - Configure Further
In the Admin interface, visit `alumni > config > add` or `<AUTH-URL>/admin/alumni/config/add/`
Select the Alliances and/or Corporations for which characters with historical membership are Alumni
## Settings
| Name | Description | Default |
| --- | --- | --- |
|`ALUMNI_CHARACTERCORPORATION_RATELIMIT`| Celery Rate Limit _per worker_, 10 tasks * 10 Workers = 100 tasks/min | '10/m' |
## 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": null,
"name": "aa-alumni",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "allianceauth, eveonline",
"author": null,
"author_email": "Joel Falknau <joel.falknau@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c3/f8/c985011036c8a224aafdd8956c70fda18a167c865384d626823c27685304/aa_alumni-0.3.0.tar.gz",
"platform": null,
"description": "# Alliance Auth - Alumni\n\n## Features\n\n- Integration with Alliance Auth's State System, creates and maintains an Alumni State for past members of an Alliance and/or Corporation.\n\n## Installation\n\n### Step 1 - Prepare Auth\n\nRemove/Promote any state with a priority of `1`, Alumni is considered slightly better than the built in Guest State.\n\n### Step 2 - Install from pip\n\n```shell\npip install aa-alumni\n```\n\n### Step 3 - Configure Auth settings\n\nConfigure your Auth settings (`local.py`) as follows:\n\n- Add `'alumni'` to `INSTALLED_APPS`\n- Add below lines to your settings file:\n\n```python\n## Settings for AA-Alumni\n# Tasks\nCELERYBEAT_SCHEDULE['alumni_run_alumni_check_all'] = {\n 'task': 'alumni.tasks.run_alumni_check_all',\n 'schedule': crontab(minute=37, hour=3, day_of_week=4),\n}\nCELERYBEAT_SCHEDULE['alumni_run_update_all_models'] = {\n 'task': 'alumni.tasks.update_all_models',\n 'schedule': crontab(minute=37, hour=3, day_of_week=3),\n}\n```\n\n### Step 4 - Update AA's State system\n\n```shell\npython myauth/manage.py alumni_state\n```\n\n### Step 5 - 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 6 - Configure Further\n\nIn the Admin interface, visit `alumni > config > add` or `<AUTH-URL>/admin/alumni/config/add/`\nSelect the Alliances and/or Corporations for which characters with historical membership are Alumni\n\n## Settings\n\n| Name | Description | Default |\n| --- | --- | --- |\n|`ALUMNI_CHARACTERCORPORATION_RATELIMIT`| Celery Rate Limit _per worker_, 10 tasks * 10 Workers = 100 tasks/min | '10/m' |\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": null,
"summary": "Integration with Alliance Auths State System, creates and maintains an Alumni State for past members of an Alliance and/or Corporation",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://gitlab.com/tactical-supremacy/aa-alumni",
"Source": "https://gitlab.com/tactical-supremacy/aa-alumni",
"Tracker": "https://gitlab.com/tactical-supremacy/aa-alumni/-/issues"
},
"split_keywords": [
"allianceauth",
" eveonline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afcb5da73b4e69ce0c7d4994fd0ab869ce8d91893e3f8e1921daa7809ae69b2c",
"md5": "d38d81d9ed0dddd7ac226887c6805566",
"sha256": "73062aa19ae17b7d10d94a6587e3a76bf004a9590f6e469fe5dc18aa5c3fb87b"
},
"downloads": -1,
"filename": "aa_alumni-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d38d81d9ed0dddd7ac226887c6805566",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14835,
"upload_time": "2024-12-04T13:13:06",
"upload_time_iso_8601": "2024-12-04T13:13:06.634777Z",
"url": "https://files.pythonhosted.org/packages/af/cb/5da73b4e69ce0c7d4994fd0ab869ce8d91893e3f8e1921daa7809ae69b2c/aa_alumni-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3f8c985011036c8a224aafdd8956c70fda18a167c865384d626823c27685304",
"md5": "d943ae5bb936fd0338d0b15b810201bb",
"sha256": "1e5e9cfdc10bddb4fd788d50c3a72ec47b532302c709e05c3d1f1cf931d187f2"
},
"downloads": -1,
"filename": "aa_alumni-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "d943ae5bb936fd0338d0b15b810201bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9855,
"upload_time": "2024-12-04T13:13:08",
"upload_time_iso_8601": "2024-12-04T13:13:08.294099Z",
"url": "https://files.pythonhosted.org/packages/c3/f8/c985011036c8a224aafdd8956c70fda18a167c865384d626823c27685304/aa_alumni-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 13:13:08",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "tactical-supremacy",
"gitlab_project": "aa-alumni",
"lcname": "aa-alumni"
}
