# AllianceAuth CharLink
[](https://pypi.org/project/aa-charlink/)
A simple app for AllianceAuth that allows users to link each character to all the AllianceAuth apps with only 1 login action.
## Overview
### Basic usage
1. Select which app you want to link your character to
2. Login on CPP site
3. Character linked to the selected apps
### Auditing
Users with the appropriate permission (see [permissions](#permissions)) can audit the linked characters of the users of their corporation, alliance or auth state. A link will appear on top of the main page of the app and will redirect to a page with a table of all the linked characters of the users of the selected corporation.
A user can be audited by clicking on the link on the `Main Character` column.
NEW: Users can now audit the apps they have access to. Select the app you want to audit from the dropdown menu in the audit page.
## Installation
1. Install the app with
```shell
pip install aa-charlink
```
2. Add `'charlink',` to your `INSTALLED_APPS` in `local.py`
3. Run migrations and collectstatic
```shell
python manage.py migrate
python manage.py collectstatic
```
## Current apps
I've opened an [issue](https://github.com/Maestro-Zacht/aa-charlink/issues/1) to track the apps that have a default integration in CharLink and the WIPs. If you want another app to be supported, please comment on the issue, reach me on the [AllianceAuth discord server](https://discord.gg/fjnHAmk) or ask the developer of the app to implement an [integration via hook](#hook-integration).
## Hook integration
From version 1.1.0, CharLink supports hook integration. If you want to integrate your app with CharLink, you need to register a hook in the `auth_hooks.py` file:
```python
@hooks.register('charlink')
def register_charlink_hook():
return 'testauth.testapp.charlink_hook'
```
The hook has to return a string with the import path of the module containing the app integration. The module must contain a variable called `app_import` which is an instance of `charlink.app_imports.utils.AppImport`. You can find the documentation of the class in the [`utils.py`](./charlink/app_imports/utils.py) and some examples in the [imports folder](./charlink/imports).
## Settings
| Name | Description | Default |
| ---------------------- | ----------------------------------------------------------------------------------- | ------- |
| `CHARLINK_IGNORE_APPS` | List of apps to ignore. Use the name of the app as it is called in `INSTALLED_APPS` | `[]` |
## Permissions
| Name | Description |
| ------------------------ | ---------------------------------------------------------- |
| `charlink.view_corp` | Can view linked character of members of their corporation. |
| `charlink.view_alliance` | Can view linked character of members of their alliance. |
| `charlink.view_state` | Can view linked character of members of their auth state. |
## Login page url
If you want to setup a template override to link the "Add character" button to the login page of this package, set the `a` element to:
```html
<a href="{% url 'charlink:index' %}" class="btn btn-block btn-info" title="Add Character">{% translate 'Add Character' %}</a>
```
## Known issues
- For AFAT is not possible to check if the added character has a token which is still valid, it only checks if the character has ever added a token with the required scopes.
Raw data
{
"_id": null,
"home_page": null,
"name": "aa-charlink",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": "allianceauth, eveonline, allianceauth_charlink, charlink",
"author": null,
"author_email": "Matteo Ghia <matteo.ghia@yahoo.it>",
"download_url": "https://files.pythonhosted.org/packages/b3/96/5b07fddd1076f9d8342ac9dd92284429c6af2fb9099260a26ade8f83c510/aa_charlink-1.3.0.tar.gz",
"platform": null,
"description": "# AllianceAuth CharLink\n\n[](https://pypi.org/project/aa-charlink/)\n\nA simple app for AllianceAuth that allows users to link each character to all the AllianceAuth apps with only 1 login action.\n\n## Overview\n\n### Basic usage\n\n1. Select which app you want to link your character to\n \n2. Login on CPP site\n3. Character linked to the selected apps\n \n\n### Auditing\n\nUsers with the appropriate permission (see [permissions](#permissions)) can audit the linked characters of the users of their corporation, alliance or auth state. A link will appear on top of the main page of the app and will redirect to a page with a table of all the linked characters of the users of the selected corporation.\n\nA user can be audited by clicking on the link on the `Main Character` column.\n\nNEW: Users can now audit the apps they have access to. Select the app you want to audit from the dropdown menu in the audit page.\n\n## Installation\n\n1. Install the app with\n\n ```shell\n pip install aa-charlink\n ```\n\n2. Add `'charlink',` to your `INSTALLED_APPS` in `local.py`\n3. Run migrations and collectstatic\n\n ```shell\n python manage.py migrate\n python manage.py collectstatic\n ```\n\n## Current apps\n\nI've opened an [issue](https://github.com/Maestro-Zacht/aa-charlink/issues/1) to track the apps that have a default integration in CharLink and the WIPs. If you want another app to be supported, please comment on the issue, reach me on the [AllianceAuth discord server](https://discord.gg/fjnHAmk) or ask the developer of the app to implement an [integration via hook](#hook-integration).\n\n## Hook integration\n\nFrom version 1.1.0, CharLink supports hook integration. If you want to integrate your app with CharLink, you need to register a hook in the `auth_hooks.py` file:\n\n```python\n@hooks.register('charlink')\ndef register_charlink_hook():\n return 'testauth.testapp.charlink_hook'\n```\n\nThe hook has to return a string with the import path of the module containing the app integration. The module must contain a variable called `app_import` which is an instance of `charlink.app_imports.utils.AppImport`. You can find the documentation of the class in the [`utils.py`](./charlink/app_imports/utils.py) and some examples in the [imports folder](./charlink/imports).\n\n## Settings\n\n| Name | Description | Default |\n| ---------------------- | ----------------------------------------------------------------------------------- | ------- |\n| `CHARLINK_IGNORE_APPS` | List of apps to ignore. Use the name of the app as it is called in `INSTALLED_APPS` | `[]` |\n\n## Permissions\n\n| Name | Description |\n| ------------------------ | ---------------------------------------------------------- |\n| `charlink.view_corp` | Can view linked character of members of their corporation. |\n| `charlink.view_alliance` | Can view linked character of members of their alliance. |\n| `charlink.view_state` | Can view linked character of members of their auth state. |\n\n## Login page url\n\nIf you want to setup a template override to link the \"Add character\" button to the login page of this package, set the `a` element to:\n\n```html\n<a href=\"{% url 'charlink:index' %}\" class=\"btn btn-block btn-info\" title=\"Add Character\">{% translate 'Add Character' %}</a>\n```\n\n## Known issues\n\n- For AFAT is not possible to check if the added character has a token which is still valid, it only checks if the character has ever added a token with the required scopes.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Character Linker for Alliance Auth",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/Maestro-Zacht/aa-charlink/releases",
"Homepage": "https://github.com/Maestro-Zacht/aa-charlink",
"Source": "https://github.com/Maestro-Zacht/aa-charlink",
"Tracker": "https://github.com/Maestro-Zacht/aa-charlink/issues"
},
"split_keywords": [
"allianceauth",
" eveonline",
" allianceauth_charlink",
" charlink"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4c73449cec79f7c6f1e46557748c534e3d60c85cd9811c844ae7d805cdda8bf",
"md5": "fe35d8fa025d6612d158bf5433474d00",
"sha256": "4c2fb90ab29ffeae178d5eb70f7e160d37ecb3fc79c901e1cb2e4a7e09d47219"
},
"downloads": -1,
"filename": "aa_charlink-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe35d8fa025d6612d158bf5433474d00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 61049,
"upload_time": "2024-05-19T17:46:27",
"upload_time_iso_8601": "2024-05-19T17:46:27.485194Z",
"url": "https://files.pythonhosted.org/packages/f4/c7/3449cec79f7c6f1e46557748c534e3d60c85cd9811c844ae7d805cdda8bf/aa_charlink-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3965b07fddd1076f9d8342ac9dd92284429c6af2fb9099260a26ade8f83c510",
"md5": "1c510ecb9e9790dd4cf49d33ec339202",
"sha256": "eaf34ac860661c3cfa968063e451323f9fa0390573d261c6ab024ab108f3bd75"
},
"downloads": -1,
"filename": "aa_charlink-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1c510ecb9e9790dd4cf49d33ec339202",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 38529,
"upload_time": "2024-05-19T17:46:30",
"upload_time_iso_8601": "2024-05-19T17:46:30.158305Z",
"url": "https://files.pythonhosted.org/packages/b3/96/5b07fddd1076f9d8342ac9dd92284429c6af2fb9099260a26ade8f83c510/aa_charlink-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 17:46:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Maestro-Zacht",
"github_project": "aa-charlink",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "aa-charlink"
}
JSON
