aa-routing


Nameaa-routing JSON
Version 0.2.1a0 PyPI version JSON
download
home_page
SummaryAllianceAuth Routing and Pathfinding
upload_time2023-11-08 12:18:10
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.
            # Routing for Alliance Auth

Routing is a pathfinding plugin for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/).

## Features

- def route_path(source: int, destination: int, mode="p_shortest",  algorithm="astar", edges: list = [], static_cache: bool = False) -> List[int]:
- def route_length(source: int, destination: int, mode="p_shortest",  algorithm="astar", edges: List = [], static_cache: bool = False ) -> int:
- def systems_range(source: int, range: int, mode="p_shortest", edges: list = [], static_cache: bool = False) -> List:

- A pregenerated optional Graph dict, to reduce DB load and processing for mass use, cannot guarantee accuracy without shipping new versions.

## Implementations

### Planned

AA Drifters
AA Incursions

## Installation

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

### Step 1 - Install app

```shell
pip install aa-routing
```

### Step 2 - Configure Auth settings

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

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

### Step 3 - Maintain Alliance Auth

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

### Step 4 - Configuration

In the Admin interface, visit `routing` or `<AUTH-URL>/admin/routing`

## Settings

| Name | Description | Default |
| --- | --- | --- |

## 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-routing",
    "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/af/55/3bae6ee2d59294fff570727b2c7d251baebf1168b3ac5a7db9a3e543d2bf/aa_routing-0.2.1a0.tar.gz",
    "platform": null,
    "description": "# Routing for Alliance Auth\n\nRouting is a pathfinding plugin for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/).\n\n## Features\n\n- def route_path(source: int, destination: int, mode=\"p_shortest\",  algorithm=\"astar\", edges: list = [], static_cache: bool = False) -> List[int]:\n- def route_length(source: int, destination: int, mode=\"p_shortest\",  algorithm=\"astar\", edges: List = [], static_cache: bool = False ) -> int:\n- def systems_range(source: int, range: int, mode=\"p_shortest\", edges: list = [], static_cache: bool = False) -> List:\n\n- A pregenerated optional Graph dict, to reduce DB load and processing for mass use, cannot guarantee accuracy without shipping new versions.\n\n## Implementations\n\n### Planned\n\nAA Drifters\nAA Incursions\n\n## Installation\n\nRouting is an App for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/), Please make sure you have this installed. Routing is not a standalone Django Application\n\n### Step 1 - Install app\n\n```shell\npip install aa-routing\n```\n\n### Step 2 - Configure Auth settings\n\nConfigure your Auth settings (`local.py`) as follows:\n\n- Add `'routing'` to `INSTALLED_APPS`\n- Add below lines to your settings file:\n\n### Step 3 - 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 4 - Configuration\n\nIn the Admin interface, visit `routing` or `<AUTH-URL>/admin/routing`\n\n## Settings\n\n| Name | Description | Default |\n| --- | --- | --- |\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": "AllianceAuth Routing and Pathfinding",
    "version": "0.2.1a0",
    "project_urls": {
        "Homepage": "https://gitlab.com/tactical-supremacy/aa-routing",
        "Source": "https://gitlab.com/tactical-supremacy/aa-routing",
        "Tracker": "https://gitlab.com/tactical-supremacy/aa-routing/-/issues"
    },
    "split_keywords": [
        "allianceauth",
        "eveonline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be464a025e27e831573a03cd54510532d7a6a4b7182e3d9f469bf71dd488b3fb",
                "md5": "51f9a6c94ea7dc29aa05b1447b903050",
                "sha256": "36d97f22b62ab8052c473cc2d13f7cbd51f8ac35f551553106c11b8c64b10ff5"
            },
            "downloads": -1,
            "filename": "aa_routing-0.2.1a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "51f9a6c94ea7dc29aa05b1447b903050",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 76143,
            "upload_time": "2023-11-08T12:18:09",
            "upload_time_iso_8601": "2023-11-08T12:18:09.203307Z",
            "url": "https://files.pythonhosted.org/packages/be/46/4a025e27e831573a03cd54510532d7a6a4b7182e3d9f469bf71dd488b3fb/aa_routing-0.2.1a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af553bae6ee2d59294fff570727b2c7d251baebf1168b3ac5a7db9a3e543d2bf",
                "md5": "c2d6b004c074d0608ed5714fb3acbf18",
                "sha256": "05838f35f6004475fe449a201788eac90bace542011900cc84a34c7f8f1a951e"
            },
            "downloads": -1,
            "filename": "aa_routing-0.2.1a0.tar.gz",
            "has_sig": false,
            "md5_digest": "c2d6b004c074d0608ed5714fb3acbf18",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 69391,
            "upload_time": "2023-11-08T12:18:10",
            "upload_time_iso_8601": "2023-11-08T12:18:10.717377Z",
            "url": "https://files.pythonhosted.org/packages/af/55/3bae6ee2d59294fff570727b2c7d251baebf1168b3ac5a7db9a3e543d2bf/aa_routing-0.2.1a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-08 12:18:10",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "tactical-supremacy",
    "gitlab_project": "aa-routing",
    "lcname": "aa-routing"
}
        
Elapsed time: 0.13904s