Skip to main content

Configurable Report Framework for corporate level aggregation of any data

Project description

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
  • Data Exportable to CSV for external manipulation.

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 plus button in the menubar

The General Road Map

if you want some features, please create an issue.

  • state level report that shows all members of a state
  • group reports for group leaders
  • overview screen with passing/failing per corp per "report" ( maybe have this as optional aka "show_on_global_overview_report" )
  • more things...

Filters/stats provided by this app

  • show all alts for a main, with option to only show in corp alts

Other Apps with filters

... more send a PR in with updates

Installation

Bare Metal

  1. pip install -U allianceauth-auth-stats
  2. add 'authstats', to your local.py
  3. migrate python manage.py migrate
  4. collectstatic python manage.py collectstatic --noinput
  5. sync commands python manage.py reports_sync_filters
  6. create your first report python manage.py reports_bootstrap_report
  7. restart auth
  8. continue to the common section

Docker

  1. add allianceauth-auth-stats==0.0.1 (update version number as required) to your requirements.txt file and rebuild your containers docker compose build --no-cache
  2. add 'authstats', to your local.py
  3. recreate you docker stack docker compose up -d
  4. enter your auth container and run migrations and collect static and sync filters docker compose exec alliancauth_gunicorn bash
  • auth collectstatic
  • auth migrate
  • auth reports_sync_filters
  • auth reports_bootstrap_report
  1. continue to the common section

Common setup steps

  1. In the auth admin site edit Auth Reports Configuration to your liking.
  2. set your states to include in reports as a minimum.
  3. add permissions to the parties you wish to be able to use reports. permisions are defined below.

Screenshots

Imgur

Imgur

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.
restricted_reports nill Can access restricted reports. Allows access to any report with restricted enabled
holding_corps nill Can access configured holding corp reports. Allows access to holding corporation reports

Note: Configure the "Holding Corps" in the Auth Reports Configuration Admin Model. via the auth admin interface.

Contributing

Make sure you have signed the 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

allianceauth_auth_stats-0.1.1.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

allianceauth_auth_stats-0.1.1-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file allianceauth_auth_stats-0.1.1.tar.gz.

File metadata

  • Download URL: allianceauth_auth_stats-0.1.1.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for allianceauth_auth_stats-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5f276052b0e8ed45f33689bfff2557fd74c7493cc97cb7ccc450d2e85d4f47ce
MD5 e264b6d1936673317ca7dc901b5f36b1
BLAKE2b-256 3e9bb3da09fad8fc1c938a052e4536c623924d8628157c0b07c48e979b602cec

See more details on using hashes here.

File details

Details for the file allianceauth_auth_stats-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for allianceauth_auth_stats-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65173a7797ab082e4b5e01f9de97546b5dbae8a5a42c11f43efc05caa53be9f9
MD5 a7acf351122f2c8ed34c7d350a4c0f83
BLAKE2b-256 21b8eb04b87214e09e8714b31000c04fe5743af99e7f93c337b634588c921d2d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page