aa-incursions


Nameaa-incursions JSON
Version 0.6.1a0 PyPI version JSON
download
home_pageNone
SummaryAllianceAuth Incursion Tools
upload_time2024-07-05 08:45:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
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.10",
    "maintainer_email": null,
    "keywords": "allianceauth, eveonline",
    "author": null,
    "author_email": "Joel Falknau <joel.falknau@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/53/25/7e12e9b9711806104aa813fd844d7df1fd88aa490ea140d76a987b5dc0f9/aa_incursions-0.6.1a0.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.6.1a0",
    "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": "1f349ecc87499916b02cc7a8ce7b82857fbcbaa72c76af953075e2dfe4842b27",
                "md5": "786f54d4562b52b13440caf0c5c0de6d",
                "sha256": "ba8bec4cee27b135636d9161e86d08e9582a0a0f1b670bf2ab856b5c7fd3f3a3"
            },
            "downloads": -1,
            "filename": "aa_incursions-0.6.1a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "786f54d4562b52b13440caf0c5c0de6d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 3285481,
            "upload_time": "2024-07-05T08:44:22",
            "upload_time_iso_8601": "2024-07-05T08:44:22.893561Z",
            "url": "https://files.pythonhosted.org/packages/1f/34/9ecc87499916b02cc7a8ce7b82857fbcbaa72c76af953075e2dfe4842b27/aa_incursions-0.6.1a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "53257e12e9b9711806104aa813fd844d7df1fd88aa490ea140d76a987b5dc0f9",
                "md5": "118468634f29fdba96f2df9af9fc9c5b",
                "sha256": "c03489ae79ab87bd2e82475763594eac3a080eadde4f40fe8910d1dbbeaa0f7e"
            },
            "downloads": -1,
            "filename": "aa_incursions-0.6.1a0.tar.gz",
            "has_sig": false,
            "md5_digest": "118468634f29fdba96f2df9af9fc9c5b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 3264280,
            "upload_time": "2024-07-05T08:45:24",
            "upload_time_iso_8601": "2024-07-05T08:45:24.222081Z",
            "url": "https://files.pythonhosted.org/packages/53/25/7e12e9b9711806104aa813fd844d7df1fd88aa490ea140d76a987b5dc0f9/aa_incursions-0.6.1a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-05 08:45:24",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "tactical-supremacy",
    "gitlab_project": "aa-incursions",
    "lcname": "aa-incursions"
}
        
Elapsed time: 0.31110s