Skip to main content

This module is the core of the CorpTools Ecosystem

Project description

CorpTools

CI PyPI version Discord

Lightweight Toolbox of Bits and bobs for todays Eve Group on the go!

This module is the core of the CorpTools Ecosystem, this includes;

  • Invoices: Automatic tracking of payments made to a holding wallet.
  • Moons: Moon Mining tracking and Tax system.
  • Indy Dash: What Industrial structures have what rigs and where are they.
  • Pinger: High performance pings from the notification endpoint, using the data avaialbe from character audit.

Included Bits and Bobs:

  • Character Audit

    • Assets
    • Roles
    • Contacts
    • Notifications
    • Standings
    • Markets
    • Skills
      • List
      • Queue
      • Audit/Export
    • Wallet
      • Activity Analysis
    • History
    • Clones
      • Implants
  • Corp Audit

    • Wallets
    • Structures
    • Assets
  • Sec Group Filters

    • Audit Fully Loaded
    • Assets
      • Location
      • Type
      • Group
    • Skill List
    • Corporate Roles
    • Corporate Title
    • Main time in corp

Active Devs:

Installation

  1. Install the Repo from git pip install -U git+https://github.com/pvyParts/allianceauth-corp-tools.git
  2. Add 'corptools', to your INSTALLED_APPS in your projects local.py
  3. run migrations, collectstatic and restart auth
  4. run the corp tools setup managemnt command python manage.py ct_setup
  5. setup your perms as documented below
  6. add characters and corp tokens as required.

Set Corp Tools Name

Add the below lines to your local.py settings file, Changing the contexts to yours.

You can optionally se the name of the app in the ui by setting this setting

## name for Corp Tools
CORPTOOLS_APP_NAME = "Character Audit"

Usage

Seting up automatic updates

This will show how to do daily updates.

Currently this is:

  • 2 times an hour ( minute 15, and 45) 1/48th of the total character updates, for at worst 1 update per character per day
  • Corp update run on all corps hourly at minute 30
  1. Got Audit Admin
  2. Click Create or Update Periodic Tasks
  3. you can edit the schedules to work more inline with your group as required.

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.

Character

Perm Admin Site Perm Description
view_characteraudit nill Can view character audit. Generic Access perm to show the Member Audit Menu item
global_hr nill Can access other character's data for characters in any corp/alliance/state. Superuser level access
alliance_hr nill Can access other character's data for own alliance. Alliance only level access
corp_hr nill Can access other character's data for own corp. Own Corp restricted level access

Corporate

Perm Admin Site Perm Description
global_corp_manager nill Can access other character's data for characters in any corp/alliance/state. Superuser level access
alliance_corp_manager nill Can access other character's data for own alliance. Alliance only level access
own_corp_manager nill Can access other character's data for own corp. Own Corp restricted level access
holding_corp_structures nill Can access configured holding corp structure data. Holding Corp Structure data access
holding_corp_wallets nill Can access configured holding corp wallet data. Holding Corp Structure data access
holding_corp_assets nill Can access configured holding corp asset data. Holding Corp Structure data access

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

Settings

Modules

Each section of the character audit can be enabled and disabled via settings in your local.py

  • True Enables the module
  • False Disables the Module

You can also exclude section of hte updates from the "Active" metric, this is handy should you wish to add a module and not have everyone be marked as "Inactive" in the audit module. or if CCP is having issues with part of the ESI. Looks at Assets

  • True Masks the section in the active calculation
  • False Enforces the section in the active calculation

To assist with auth related tasks we request publicData on top of the configured set.

Module Enable Setting (Default) Active Setting (Default) Description Scopes Requested Note
Assets CT_CHAR_ASSETS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_ASSETS_MODULE (False) Character Assets 'esi-assets.read_assets.v1' Fully enabled with a Sec Group Filter
Standings CT_CHAR_STANDINGS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_STANDINGS_MODULE (False) Character NPC Standings 'esi-characters.read_standings.v1' Fully enabled
Killmails CT_CHAR_KILLMAILS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_KILLMAILS_MODULE (False) Character Killmails 'esi-killmails.read_killmails.v1' Future Version
Fittings CT_CHAR_FITTINGS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_FITTINGS_MODULE (False) Character Fittings 'esi-fittings.read_fittings.v1' Future Version
Calendar CT_CHAR_CALENDAR_MODULE (True) CT_CHAR_ACTIVE_IGNORE_CALENDAR_MODULE (False) Character Killmails 'esi-calendar.read_calendar_events.v1' Future Version
Contacts CT_CHAR_CONTACTS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_CONTACTS_MODULE (False) Character Contacts 'esi-characters.read_contacts.v1' Fully enabled
Notifications CT_CHAR_NOTIFICATIONS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_NOTIFICATIONS_MODULE (False) Character Notifications 'esi-characters.read_notifications.v1' Fully enabled
Roles CT_CHAR_ROLES_MODULE (True) CT_CHAR_ACTIVE_IGNORE_ROLES_MODULE (False) Character Roles and Titles 'esi-characters.read_titles.v1', 'esi-characters.read_corporation_roles.v1' Fully enabled with a Sec Group Filter
Industry CT_CHAR_INDUSTRY_MODULE (True) CT_CHAR_ACTIVE_IGNORE_INDUSTRY_MODULE (False) Character Indy Jobs 'esi-industry.read_character_jobs.v1' Fully enabled
Mining CT_CHAR_MINING_MODULE (True) CT_CHAR_ACTIVE_IGNORE_MINING_MODULE (False) Character Mining Ledgers 'esi-industry.read_character_mining.v1' Future Version
Wallets/Markets/Contracts CT_CHAR_WALLET_MODULE (True) CT_CHAR_ACTIVE_IGNORE_WALLET_MODULE (False) Character Wallets, Contracts and Trading/Orders 'esi-markets.read_character_orders.v1', 'esi-wallet.read_character_wallet.v1', 'esi-contracts.read_character_contracts.v1' Fully Enabled
Skills CT_CHAR_SKILLS_MODULE (True) CT_CHAR_ACTIVE_IGNORE_SKILLS_MODULE (False) Character Skills/Queues and Doctrine Tools 'esi-skills.read_skillqueue.v1','esi-skills.read_skills.v1' Fully Enabled with Sec Group Filters
Clones CT_CHAR_CLONES_MODULE (True) CT_CHAR_ACTIVE_IGNORE_CLONES_MODULE (False) Character Medical and Jump Clone Module 'esi-clones.read_implants.v1', 'esi-clones.read_clones.v1' Fully Enabled with a Sec Group Filter
Fleet CT_CHAR_FLEET_MODULE (True) nill Character Fleet Tools 'esi-fleets.read_fleet.v1', 'esi-fleets.write_fleet.v1` Future Version
Mail CT_CHAR_MAIL_MODULE (False) CT_CHAR_ACTIVE_IGNORE_MAIL_MODULE (False) Character Mail Views 'esi-mail.read_mail.v1` Fully Enabled
Helpers CT_CHAR_HELPER_MODULE (False) CT_CHAR_ACTIVE_IGNORE_HELPER_MODULE (False) Character Helpers 'esi-ui.open_window.v1','esi-ui.write_waypoint.v1' Future Versions
Opportunities CT_CHAR_OPPORTUNITIES (False) nill Character Opportunities 'esi-characters.read_opportunities.v1' Future Versions
Loyalty Points CT_CHAR_LOYALTYPOINTS_MODULE (False) CT_CHAR_ACTIVE_IGNORE_LOYALTYPOINTS_MODULE (True) Character LP 'esi-characters.read_loyalty.v1' Fully Enabled

Extra Scopes

If Assets, Clones, Wallets or Minning are enabled these extra spoces are requested:

  • 'esi-universe.read_structures.v1'
  • 'esi-search.search_structures.v1'

Other Settings

Setting Default Description
CORPTOOLS_APP_NAME "Character Audit" Name on the menu for Character Audit
CT_CHAR_MAX_INACTIVE_DAYS 3 Days till data is considered Stale
CORPTOOLS_DISCORD_BOT_COGS ["corptools.cogs.routes", "corptools.cogs.locate"] Discord bot cogs to enable/disable
CT_PAGINATION_SIZE 30000 Max items per page of data in the UI
CT_USERS_CAN_FORCE_REFRESH False Set to True to force cache invalidation on a regular user requresting updates from the UI. Superusers will always cache invalidate on requesting an update.

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_corptools-2.8.0b1.tar.gz (3.9 MB view details)

Uploaded Source

Built Distribution

allianceauth_corptools-2.8.0b1-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file allianceauth_corptools-2.8.0b1.tar.gz.

File metadata

File hashes

Hashes for allianceauth_corptools-2.8.0b1.tar.gz
Algorithm Hash digest
SHA256 73181546e9c17aebc25310f3a9bcff0ea3820dfc325ca9018b9bf2081375ba0a
MD5 3e2035aeea41acfe84646c1f9d18e908
BLAKE2b-256 9593e2f33ded58b7697c462c4f4185793015b0f3948dcad280c8a79416314dc1

See more details on using hashes here.

File details

Details for the file allianceauth_corptools-2.8.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for allianceauth_corptools-2.8.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c5268b78ae5aef760d7ce202a700cd923fe2f682c4c48d0b8a2b39da04ba87a
MD5 9033b670dc9fe4893be5e31e54cc2eb9
BLAKE2b-256 f4c6d5b0e9f4193398168fa20f112f7a54bd92cc0520f4212e7c7060a029c5cc

See more details on using hashes here.

Supported by

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