Metadata-Version: 2.1
Name: aa-blueprints
Version: 1.1.1
Summary: Blueprint Library plugin for Alliance Auth
Home-page: https://gitlab.com/eclipse-expeditions/aa-blueprints
Author: Rebecca Murphy
Author-email: rebecca@rcmurphy.me
License: GPL
Description: # AA Blueprints
        
        This is an blueprints library app for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) (AA) that can be used to list blueprints for your corporation or alliance.
        
        ![release](https://img.shields.io/pypi/v/aa-blueprints?label=release)
        ![License](https://img.shields.io/badge/license-GPL-green)
        ![python](https://img.shields.io/pypi/pyversions/aa-blueprints)
        ![django](https://img.shields.io/pypi/djversions/aa-blueprints?label=django)
        ![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
        ![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
        
        # Overview
        
        ## Features
        
        - Lists blueprints owned by corporation or alliance (configurable with permissions)
        - Collects requests for blueprint copies
        
        ## Screenshots
        
        ### Library
        
        ![library](https://i.imgur.com/62eUbB8.png)
        
        ### View Blueprint
        
        ![view-blueprint](https://i.imgur.com/g8ge0gA.png)
        
        ### Create a Request
        
        ![create-request](https://i.imgur.com/MSt7mZg.png)
        
        ### My Requests
        
        ![my-requests](https://i.imgur.com/0Tj5jo6.png)
        
        ### Open Requests
        
        ![open-requests](https://i.imgur.com/pQMuLEQ.png)
        
        ### Manage Blueprints
        
        ![manage-blueprints](https://i.imgur.com/ap1vc4h.png)
        
        # Installation
        
        ## Requirements
        
        AA Blueprints needs the app [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse) to function. Please make sure it is installed before before continuing.
        
        ## Steps
        
        ### Step 1 - Install the Package
        
        Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
        
        `pip install aa-blueprints`
        
        ### Step 2 - Configure AA
        
        - Add 'blueprints' to `INSTALLED_APPS` in `settings/local.py`.
        - Add the following automated task definition:
        
        
        ```python
        CELERYBEAT_SCHEDULE['blueprints_update_all_blueprints'] = {
            'task': 'blueprints.tasks.update_all_blueprints',
            'schedule': crontab(minute=0, hour='*/3'),
        }
        CELERYBEAT_SCHEDULE['blueprints_update_all_industry_jobs'] = {
            'task': 'blueprints.tasks.update_all_industry_jobs',
            'schedule': crontab(minute=0, hour='*'),
        }
        CELERYBEAT_SCHEDULE['blueprints_update_all_locations'] = {
            'task': 'blueprints.tasks.update_all_locations',
            'schedule': crontab(minute=0, hour='*/12'),
        }
        ```
        
        ### Step 3 - Finalize App installation
        
        Run migrations & copy static files:
        
        ```bash
        python manage.py migrate
        python manage.py collectstatic
        ```
        
        Restart your supervisor services for Auth
        
        ### Step 4 - Update EVE Online API Application
        
        Update the Eve Online API app used for authentication in your AA installation to include the following scopes:
        
         - `esi-assets.read_assets.v1`
         - `esi-assets.read_corporation_assets.v1`
         - `esi-characters.read_blueprints.v1`
         - `esi-corporations.read_blueprints.v1`
         - `esi-industry.read_character_jobs.v1`
         - `esi-industry.read_corporation_jobs.v1`
         - `esi-universe.read_structures.v1`
        
        ### Step 5 - Data import
        
        Load EVE Online type data from ESI:
        
        ```bash
        python manage.py blueprints_load_types
        ```
        
        # Permissions
        
        | ID                               | Description                                  | Notes                                                                          |
        |----------------------------------|----------------------------------------------|--------------------------------------------------------------------------------|
        | `basic_access`                   | Can access this app                          |                                                                                |
        | `request_blueprints`             | Can request blueprints                       |                                                                                |
        | `manage_requests`                | Can review and accept blueprint requests     |                                                                                |
        | `add_personal_blueprint_owner`   | Can add personal blueprint owners            |                                                                                |
        | `add_corporate_blueprint_owner`  | Can add corporate blueprint owners           | :warning: Should only be given to directors or the CEO.                        |
        | `view_alliance_blueprints`       | Can view alliance's blueprints               |                                                                                |
        | `view_industry_jobs`             | Can view details about running industry jobs | :warning: This permission will let someone see _all_ industry job information. |
        
        # Upgrading
        See [UPGRADING.md](UPGRADING.md).
        
        # Authors
        
        The main authors (in alphabetical order):
        
        - [Erik Kalkoken](https://gitlab.com/ErikKalkoken)
        - [Rebecca Claire Murphy](https://gitlab.com/rcmurphy), aka Myrhea
        - [Peter Pfeufer](https://gitlab.com/ppfeufer), aka Rounon Dax
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
