# Auth Reports
### Auth Data in report form, in Auth, fully configurable
AKA Corp Stats 3.0
- Configurable Report Framework for corporate level aggregation of any data
- each "field" is a smart filter similar to secure groups ( can use secure groups filters too ) or a "field only" filter provided by any application in the alliance auth ecosystem.
- These filters MUST be the more modern kind with either a `process_field` or `audit_filter` methods. Legacy filters using only `process_filter` will not show any data. [Please see this link for more info](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups/blob/main/THRID_PARTY.md)
## What it needs:
- require corporate member tokens to build the corp groups to see people not known to auth, to make a report for that too. these can be added with the pluss button in the menubar
## Min Release Req's:
- [ ] a basic report that does what corpstats 2.0 does now
- [x] alts to mains
- [ ] join dates
- [ ] last login
- [x] permissions that give access to all reports at a `corp/alli/state/holding corps` level
- [ ] overview screen with passing/failing per corp per "report" ( maybe have this as optional aka "show_on_global_overview_report" )
## Nice to haves future plans
- state level report that shows all members of a state
- csv/json/other export
- more things...
## Filters/stats provided by this app
- show all alts for a main, with option to only show in corp alts
## Installation
**BETA INSTALL** This will be updated with QOL in later releases but this is still BETA software
### Bare Metal
1. `pip install allianceauth-auth-stats==0.0.1b2`
1. add `'authstats',` to your local.py
1. migrate `python manage.py migrate`
1. collectstatic `python manage.py collectstatic --noinput`
1. sync commands `python manage.py reports_sync_filters`
1. restart auth
1. continue to the common section
### Docker
1. add `allianceauth-auth-stats==0.0.1b1` to your requirements.txt file and rebuild your containers `docker compose build --no-cache`
1. add `'authstats',` and `'solo',` to your local.py
1. recreate you docker stack `docker compose up -d`
1. enter your auth container and run migrations and collect static and sync filters `docker compose exec auth bash`
- `auth collectstatic`
- `auth migrate`
- `auth reports_sync_filters`
1. continue to the common section
### Common setup steps
1. run the following command to sync all the available filters `manage.py reports_sync_filters`
1. In the auth admin site edit the `Auth Reports Configuration` to your liking.
1. set your states to include in reports at a minimum.
1. Create a new `Report Field: Character Alts` defaults are fine
1. create your first report.
- Name "Corpstats"
- Check show character images
- Setup your fields
- Don't forget to add the characters field you setup in the previous step. i recommend you uncheck sorting on this field.
1. add permissions to the parties you wish to be able to use reports. permisions are defined below.
## Screenshots
## Permissions
There are some basic access perms
All permissions are filtered by main character, if a person has neutral alts loaded they will also be visible to someone who can see their main.
| Perm | Admin Site | Perm | Description |
| ------------ | ---------- | ------------------------------------ | -------------------------------------------------------------------- |
| basic_access | nill | Can access reports module | Shows the Auth Reports module in the menu and gives access to the UI |
| own_corp | nill | Can access own corporations reports. | |
| own_alliance | nill | Can access own alliances reports. | |
| own_state | nill | Can access own states reports. | |
### Future Perms
these are not hooked up yet
| Perm | Admin Site | Perm | Description |
| ------------------ | ---------- | ------------------------------------------- | ----------- |
| restricted_reports | nill | Can access restricted reports. | |
| holding_corps | nill | Can access configured holding corp reports. | |
Note: Configure the "Holding Corps" in the `Auth Reports Configuration` Admin Model. via the auth admin interface.
## Settings
| Setting | Default | Description |
| -------------------- | -------------- | ------------------------------- |
| `AUTHSTATS_APP_NAME` | "Auth Reports" | Name on the menu for Auth Stats |
## 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": "https://github.com/pvyParts/allianceauth-corp-tools",
"name": "allianceauth-auth-stats",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "AaronKable",
"author_email": "aaronkable@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/82/1a/1f63d56faada39d8bf80cf195e7667298e053aa07af6e12f7189ceec4140/allianceauth-auth-stats-0.0.1b3.tar.gz",
"platform": null,
"description": "# Auth Reports\n\n### Auth Data in report form, in Auth, fully configurable\n\nAKA Corp Stats 3.0\n\n- Configurable Report Framework for corporate level aggregation of any data\n- each \"field\" is a smart filter similar to secure groups ( can use secure groups filters too ) or a \"field only\" filter provided by any application in the alliance auth ecosystem.\n - These filters MUST be the more modern kind with either a `process_field` or `audit_filter` methods. Legacy filters using only `process_filter` will not show any data. [Please see this link for more info](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups/blob/main/THRID_PARTY.md)\n\n## What it needs:\n\n- require corporate member tokens to build the corp groups to see people not known to auth, to make a report for that too. these can be added with the pluss button in the menubar\n\n## Min Release Req's:\n\n- [ ] a basic report that does what corpstats 2.0 does now\n - [x] alts to mains\n - [ ] join dates\n - [ ] last login\n- [x] permissions that give access to all reports at a `corp/alli/state/holding corps` level\n- [ ] overview screen with passing/failing per corp per \"report\" ( maybe have this as optional aka \"show_on_global_overview_report\" )\n\n## Nice to haves future plans\n\n- state level report that shows all members of a state\n- csv/json/other export\n- more things...\n\n## Filters/stats provided by this app\n\n- show all alts for a main, with option to only show in corp alts\n\n## Installation\n\n**BETA INSTALL** This will be updated with QOL in later releases but this is still BETA software\n\n### Bare Metal\n\n1. `pip install allianceauth-auth-stats==0.0.1b2`\n1. add `'authstats',` to your local.py\n1. migrate `python manage.py migrate`\n1. collectstatic `python manage.py collectstatic --noinput`\n1. sync commands `python manage.py reports_sync_filters`\n1. restart auth\n1. continue to the common section\n\n### Docker\n\n1. add `allianceauth-auth-stats==0.0.1b1` to your requirements.txt file and rebuild your containers `docker compose build --no-cache`\n1. add `'authstats',` and `'solo',` to your local.py\n1. recreate you docker stack `docker compose up -d`\n1. enter your auth container and run migrations and collect static and sync filters `docker compose exec auth bash`\n\n- `auth collectstatic`\n- `auth migrate`\n- `auth reports_sync_filters`\n\n1. continue to the common section\n\n### Common setup steps\n\n1. run the following command to sync all the available filters `manage.py reports_sync_filters`\n1. In the auth admin site edit the `Auth Reports Configuration` to your liking.\n1. set your states to include in reports at a minimum.\n1. Create a new `Report Field: Character Alts` defaults are fine\n1. create your first report.\n\n- Name \"Corpstats\"\n- Check show character images\n- Setup your fields\n- Don't forget to add the characters field you setup in the previous step. i recommend you uncheck sorting on this field.\n\n1. add permissions to the parties you wish to be able to use reports. permisions are defined below.\n\n## Screenshots\n\n\n\n\n\n## Permissions\n\nThere are some basic access perms\n\nAll permissions are filtered by main character, if a person has neutral alts loaded they will also be visible to someone who can see their main.\n\n| Perm | Admin Site | Perm | Description |\n| ------------ | ---------- | ------------------------------------ | -------------------------------------------------------------------- |\n| basic_access | nill | Can access reports module | Shows the Auth Reports module in the menu and gives access to the UI |\n| own_corp | nill | Can access own corporations reports. | |\n| own_alliance | nill | Can access own alliances reports. | |\n| own_state | nill | Can access own states reports. | |\n\n### Future Perms\n\nthese are not hooked up yet\n\n| Perm | Admin Site | Perm | Description |\n| ------------------ | ---------- | ------------------------------------------- | ----------- |\n| restricted_reports | nill | Can access restricted reports. | |\n| holding_corps | nill | Can access configured holding corp reports. | |\n\nNote: Configure the \"Holding Corps\" in the `Auth Reports Configuration` Admin Model. via the auth admin interface.\n\n## Settings\n\n| Setting | Default | Description |\n| -------------------- | -------------- | ------------------------------- |\n| `AUTHSTATS_APP_NAME` | \"Auth Reports\" | Name on the menu for Auth Stats |\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\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Alliance Auth Plugin",
"version": "0.0.1b3",
"project_urls": {
"Homepage": "https://github.com/pvyParts/allianceauth-corp-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "821a1f63d56faada39d8bf80cf195e7667298e053aa07af6e12f7189ceec4140",
"md5": "8eed57977ba3336d87aa696d35e3dd37",
"sha256": "ce01214284afa49a6bf33828ad12c9c1e71fed9f952034041eb7d72000e66b5c"
},
"downloads": -1,
"filename": "allianceauth-auth-stats-0.0.1b3.tar.gz",
"has_sig": false,
"md5_digest": "8eed57977ba3336d87aa696d35e3dd37",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1473016,
"upload_time": "2023-11-19T08:57:49",
"upload_time_iso_8601": "2023-11-19T08:57:49.070212Z",
"url": "https://files.pythonhosted.org/packages/82/1a/1f63d56faada39d8bf80cf195e7667298e053aa07af6e12f7189ceec4140/allianceauth-auth-stats-0.0.1b3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 08:57:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pvyParts",
"github_project": "allianceauth-corp-tools",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "allianceauth-auth-stats"
}
JSON
