feat: add option to ignore TCU when collecting adm

.env.example

@@ -3,6 +3,7 @@ DISCORD_APP_ID=ABCD1234
 DISCORD_CHANNEL=adm
 DISCORD_GUILD_ID=guild-id
 ALLIANCE_ID=00000000
+ALLIANCE_IGNORE_TCU=True
 DB_SERVICE=mysql
 DB_CONNECTION_STRING=root:root@127.0.0.1:3600/pydisadm
 DB_KEEP_ADM_DAYS=7

README.md

@@ -69,6 +69,7 @@ Configuration is done using environment variables or `dotenv`. See `.env.example
 - `DISCORD_GUILD_ID` - the discord server bot should be part of
 - `DISCORD_APP_ID` - the bot application ID
 - `ALLIANCE_ID` - the alliance ID for collecting ADM values, only systems owned by this alliance will be collected.
+- `ALLIANCE_IGNORE_TCU` - set to any value to ignore TCU's when collecting ADM values
 - `DB_SERVICE` - which database to use, can be: sqlite or mysql
 - `DB_CONNECTION_STRING` - the connection string
 - `DB_KEEP_ADM_DAYS` - how many days adm history should be kept in database (default 7).

pydisadm/configuration.py

@@ -28,7 +28,8 @@ def __init__(self):
             )
 
         self.alliance = {
-            'id': os.getenv('ALLIANCE_ID')
+            'id': os.getenv('ALLIANCE_ID'),
+            'ignore_tcu': os.getenv('ALLIANCE_IGNORE_TCU')
         }
 
         keep_adm_days = self.database['keep_adm_days']
@@ -61,6 +62,7 @@ def pretty_print(self):
             f'discord_app_id={self.discord["app_id"]}, ' +
             f'discord_guild_id={self.discord["guild_id"]}, ' +
             f'alliance_id={self.alliance["id"]}, ' +
+            f'alliance_ignore_tcu={self.alliance["ignore_tcu"]}, ' +
             f'db_keep_adm_days={self.database["keep_adm_days"]}, ' +
             f'db_service={self.database["service"]}, ' +
             f'db_connection_string={self.database["connection_string"]})')

pydisadm/controller/adm_controller.py

@@ -127,10 +127,13 @@ def create_system_adm(self, system, adm):
 
         return system_adm
 
-    def get_alliance_structures(self, structures, alliance_id):
+    def get_alliance_structures(self, structures, alliance_id, ignore_tcu):
         """Retrieve a list of alliance sovreignty structures"""
         structure_data = pd.DataFrame.from_dict(structures)
 
+        if ignore_tcu:
+            structure_data = structure_data[structure_data['structure_type_id'] != 32226]
+
         drop_columns = [
             'structure_id',
             'structure_type_id',
@@ -173,10 +176,10 @@ def update_system_adm_from_index(self,
 
         return (True, insert_systems['adm'][0])
 
-    def get_system_adms(self, alliance_id):
+    def get_system_adms(self, alliance_id, ignore_tcu):
         """Retrieve ADM for systems controlled by alliance"""
         structures = sovereignty_structures()
-        system_adms = self.get_alliance_structures(structures, alliance_id)
+        system_adms = self.get_alliance_structures(structures, alliance_id, ignore_tcu)
 
         system_adms.drop_duplicates(inplace=True)
 
@@ -201,7 +204,8 @@ def get_recommended_system(self):
     def update_adm_data(self):
         """Update ADM data"""
         alliance_id = self.configuration.alliance['id']
-        system_adms = self.get_system_adms(alliance_id)
+        ignore_tcu = self.configuration.alliance['ignore_tcu']
+        system_adms = self.get_system_adms(alliance_id, ignore_tcu)
 
         self.database.insert_systems(system_adms)