aa-incursions


Nameaa-incursions JSON
Version 0.5.0a0 PyPI version JSON
download
home_pageNone
SummaryAllianceAuth Incursion Tools
upload_time2024-05-26 11:40:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords allianceauth eveonline
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Incursions for Alliance Auth

Incursion Tools for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/).

![License](https://img.shields.io/badge/license-MIT-green)
![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)

![python](https://img.shields.io/badge/python-3.8-informational)
![python](https://img.shields.io/badge/python-3.9-informational)
![python](https://img.shields.io/badge/python-3.10-informational)
![python](https://img.shields.io/badge/python-3.11-informational)

![django-4.0](https://img.shields.io/badge/django-4.0-informational)

## Features

- AA-Discordbot Cogs for information about active incursions, their status and any set Focus
- Webhook notifications for new incursions and them changing state (Mobilizing/Withdrawing)

## Planned Features

- Waitlist
- AA Fittings Integration
- Secure Groups Integration

## Installation

### Step 1 - Django Eve Universe

Incursions is an App for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/), Please make sure you have this installed. incursions is not a standalone Django Application

Incursions needs the App [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse) to function. Please make sure it is installed before continuing.

### Step 2 - Install app

```shell
pip install aa-incursions
```

### Step 3 - Configure Auth settings

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

- Add `'incursions'` to `INSTALLED_APPS`
- Add below lines to your settings file:

```python
## Settings for AA-Incursions ##
# Route is Cached for 300 Seconds, if you aren't riding the Kundalini Manifest to the last minute
# Feel free to adjust this to minute='*/5'
CELERYBEAT_SCHEDULE['incursions_update_incursions'] = {
    'task': 'incursions.tasks.update_incursions',
    'schedule': crontab(minute='*/1', hour='*'),
}
```

### 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 - Pre-Load Django-EveUniverse

- `python manage.py eveuniverse_load_data map` This will load Regions, Constellations and Solar Systems

## 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-incursions",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "allianceauth, eveonline",
    "author": null,
    "author_email": "Joel Falknau <joel.falknau@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/dd/21/08d03196952f6fa5f982f939a002d68da59504c99983508e0bbc3b85760e/aa_incursions-0.5.0a0.tar.gz",
    "platform": null,
    "description": "# Incursions for Alliance Auth\n\nIncursion Tools for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/).\n\n![License](https://img.shields.io/badge/license-MIT-green)\n![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)\n\n![python](https://img.shields.io/badge/python-3.8-informational)\n![python](https://img.shields.io/badge/python-3.9-informational)\n![python](https://img.shields.io/badge/python-3.10-informational)\n![python](https://img.shields.io/badge/python-3.11-informational)\n\n![django-4.0](https://img.shields.io/badge/django-4.0-informational)\n\n## Features\n\n- AA-Discordbot Cogs for information about active incursions, their status and any set Focus\n- Webhook notifications for new incursions and them changing state (Mobilizing/Withdrawing)\n\n## Planned Features\n\n- Waitlist\n- AA Fittings Integration\n- Secure Groups Integration\n\n## Installation\n\n### Step 1 - Django Eve Universe\n\nIncursions is an App for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/), Please make sure you have this installed. incursions is not a standalone Django Application\n\nIncursions needs the App [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse) to function. Please make sure it is installed before continuing.\n\n### Step 2 - Install app\n\n```shell\npip install aa-incursions\n```\n\n### Step 3 - Configure Auth settings\n\nConfigure your Auth settings (`local.py`) as follows:\n\n- Add `'incursions'` to `INSTALLED_APPS`\n- Add below lines to your settings file:\n\n```python\n## Settings for AA-Incursions ##\n# Route is Cached for 300 Seconds, if you aren't riding the Kundalini Manifest to the last minute\n# Feel free to adjust this to minute='*/5'\nCELERYBEAT_SCHEDULE['incursions_update_incursions'] = {\n    'task': 'incursions.tasks.update_incursions',\n    'schedule': crontab(minute='*/1', hour='*'),\n}\n```\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 - Pre-Load Django-EveUniverse\n\n- `python manage.py eveuniverse_load_data map` This will load Regions, Constellations and Solar Systems\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": "AllianceAuth Incursion Tools",
    "version": "0.5.0a0",
    "project_urls": {
        "Homepage": "https://gitlab.com/tactical-supremacy/aa-incursions",
        "Source": "https://gitlab.com/tactical-supremacy/aa-incursions",
        "Tracker": "https://gitlab.com/tactical-supremacy/aa-incursions/-/issues"
    },
    "split_keywords": [
        "allianceauth",
        " eveonline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e9b9a2f284ace0fa74f4f072c05ddde0e1889f0a7ae176e96ef8427578d7b1f",
                "md5": "d8064183090d22a9154b708f1b3cebdf",
                "sha256": "00e36b90d30b595a948d8f8ff5d2d3993c8f5709dcf7e541ca0d401c866e7b11"
            },
            "downloads": -1,
            "filename": "aa_incursions-0.5.0a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d8064183090d22a9154b708f1b3cebdf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3277209,
            "upload_time": "2024-05-26T11:40:18",
            "upload_time_iso_8601": "2024-05-26T11:40:18.287666Z",
            "url": "https://files.pythonhosted.org/packages/8e/9b/9a2f284ace0fa74f4f072c05ddde0e1889f0a7ae176e96ef8427578d7b1f/aa_incursions-0.5.0a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd2108d03196952f6fa5f982f939a002d68da59504c99983508e0bbc3b85760e",
                "md5": "2a6c119ff0e57639ba8348927a546550",
                "sha256": "ef8d707d87c561431f057e0a4d4cbcfa399150056d490392feb608ddaf466eb0"
            },
            "downloads": -1,
            "filename": "aa_incursions-0.5.0a0.tar.gz",
            "has_sig": false,
            "md5_digest": "2a6c119ff0e57639ba8348927a546550",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3259099,
            "upload_time": "2024-05-26T11:40:20",
            "upload_time_iso_8601": "2024-05-26T11:40:20.594945Z",
            "url": "https://files.pythonhosted.org/packages/dd/21/08d03196952f6fa5f982f939a002d68da59504c99983508e0bbc3b85760e/aa_incursions-0.5.0a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-26 11:40:20",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "tactical-supremacy",
    "gitlab_project": "aa-incursions",
    "lcname": "aa-incursions"
}
        
Elapsed time: 0.35531s