Metadata-Version: 2.4
Name: aa-vouch
Version: 0.1.0a0
Summary: AA Vouch
Keywords: allianceauth,eveonline
Author-email: Joel Falknau <joel.falknau@gmail.com>
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Classifier: Environment :: Web Environment
Classifier: Framework :: Celery
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
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 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
License-File: LICENSE
Requires-Dist: allianceauth>=5,<6
Requires-Dist: allianceauth-securegroups
Requires-Dist: py-cord>=2,<3
Requires-Dist: celery-types ; extra == "dev"
Requires-Dist: djlint ; extra == "dev"
Requires-Dist: flake8 ; extra == "dev"
Requires-Dist: isort ; extra == "dev"
Requires-Dist: coverage ; extra == "test"
Project-URL: Homepage, https://gitlab.com/tactical-supremacy/aa-vouch
Project-URL: Source, https://gitlab.com/tactical-supremacy/aa-vouch
Project-URL: Tracker, https://gitlab.com/tactical-supremacy/aa-vouch/-/issues
Provides-Extra: dev
Provides-Extra: test

# Vouching System for Alliance Auth

Vouch System plugin for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth/).

Inspired by morons who recruit useless krabs with cyno 5

Vouch is designed as a low friction first step to assist group management, not to replace it. AA Group Management is top down, your leaders still check and approve applicants, Vouch exists as a sideways check on culture and behaviour.

Best integrated with Secure Groups, don't let people even try to apply to groups without a vouch.

## Features

- Global Vouches
- Targeted Vouches, currently scoped to Groups.
  - Separate Permission, user must be a member of said group to vouch.
- Submit vouches via discord cogs
- Incoming and outgoing vouches are visible on a WIP frontend page.
- Secure Groups Smart Filter

## Planned Features

- Frontend Vouching

## Installation

### Step 1 - Django EveOnline SDE

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

### Step 2 - Install app

```shell
pip install aa-vouch
```

### Step 3 - Configure Auth settings

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

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

```python
## Settings for AA-Vouch
#

```

### 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 - Configuration

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

- Configure a Global Webhook for vouch updates if wanted
- Configure Vouch Scopes if you desire this feature, with individual webhooks

## Permissions

| Perm | Admin Site | Perm | Description |
| --- | --- | --- | --- |
| basic_vouch | nill | Can Access Vouch - Generic Django Permission | This isn't used for anything yet, included for convention |
| vouch_global | nill | Can perform a generic global vouch action | The user may vouch someone generically without a scope |
| vouch_targeted | nill | Can perform a targeted vouch action | The user may vouch someone with a specific scope or config, ie. to a group |
| vouch_explain | nill | Can explain a user and who vouched for them | The user may run the `/vouch explain` Discord command to list every vouch on record for a character |

## 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.

