nsarchive 1.3.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

nsarchive/instances/_republic.py

@@ -0,0 +1,313 @@
+import time
+
+from supabase import create_client
+
+from ..cls.base import *
+from ..cls.archives import *
+from ..cls.republic import *
+
+from ..cls.exceptions import *
+
+
+class RepublicInstance(Instance):
+    """
+    Gère les interactions avec les votes, les archives de la république, et les fonctionnaires.
+
+    ## Informations
+    - Résultats des votes et procès: `.Vote | .Referendum | .Lawsuit`
+    - Différentes institutions: `.State | .Administration | .Government | .Assembly | .Court | .PoliceForces`
+    - Occupants des différents rôles et historique de leurs actions: `.Official`
+    """
+
+    def __init__(self, id: str, token: str) -> None:
+        super().__init__(create_client(f"https://{id}.supabase.co", token))
+    
+    """
+    ---- VOTES & REFERENDUMS ----
+    """
+
+    def get_vote(self, id: NSID) -> Vote | Referendum | Lawsuit:
+        """
+        Récupère un vote spécifique.
+
+        ## Paramètres
+        id: `NSID`\n
+            ID du vote.
+
+        ## Renvoie
+        - `.Vote | .Referendum | .Lawsuit`
+        """
+
+        id = NSID(id)
+        _data = self._get_by_ID('votes', id)
+
+        if not _data: # Pas dans les votes -> peut-être dans les procès
+            _data = self._get_by_ID('lawsuits', id)
+
+        if not _data: # Le vote n'existe juste pas
+            return None
+        elif '_type' not in _data.keys(): # Le vote est un procès
+            _data['_type'] = "lawsuit"
+
+        if _data['_type'] == 'vote':
+            vote = Vote(id, _data['title'])
+        elif _data['_type'] == 'referendum':
+            vote = Referendum(id, _data['title'])
+            vote.choices = []
+        elif _data['_type'] == 'lawsuit':
+            vote = Lawsuit(id, _data['title'])
+            vote.choices = []
+        else:
+            vote = Vote('0', 'Unknown Vote')
+
+        vote.author = _data['author_id']
+        vote.startDate = _data['start_date']
+        vote.endDate = _data['end_date']
+
+        for opt in _data['choices']:
+            option = VoteOption(opt["id"], opt["title"])
+            option.count = opt["count"]
+
+            vote.choices.append(option)
+
+        return vote
+
+    def save_vote(self, vote: Vote | Referendum | Lawsuit):
+        """
+        Sauvegarde un vote dans la base de données.
+
+        ## Paramètres
+        - vote: `.Vote`\n
+            Vote à sauvegarder
+        """
+
+        vote.id = NSID(vote.id)
+
+        _data = {
+            '_type':'vote' if type(vote) == Vote else\
+                    'referendum' if type(vote) == Referendum else\
+                    'lawsuit' if type(vote) == Lawsuit else\
+                    'unknown',
+            'id': NSID(vote.id),
+            'title': vote.title,
+            'author_id': NSID(vote.author),
+            'start_date': vote.startDate,
+            'end_date': vote.endDate,
+            'choices': [ opt.__dict__ for opt in vote.choices ]
+        }
+
+        if type(vote) == Lawsuit:
+            del _data['_type']
+            self._put_in_db('lawsuits', _data)
+        else:
+            self._put_in_db('votes', _data)
+
+    # Aucune possibilité de supprimer un vote
+
+    """
+    ---- INSTITUTION & MANDAT ----
+    """
+
+    def get_official(self, id: NSID, current_mandate: bool = True) -> Official:
+        """
+        Récupère les informations d'un fonctionnaire (mandats, contributions).
+
+        ## Paramètres
+        id: `NSID`\n
+            ID du fonctionnaire.
+        current_mandate: `bool`\n
+            Indique si l'on doit récupérer le mandat actuel ou les anciens mandats.
+
+        ## Renvoie
+        - `.Official`
+        """
+
+        id = NSID(id)
+
+        base = 'mandate' if current_mandate else 'archives'
+
+        _contributions = self.fetch(base, author = id, _type = 'contrib')
+        _mandates = self.fetch(base, target = id, _type = 'election') +\
+                    self.fetch(base, target = id, _type = 'promotion')
+
+        user = Official(id)
+        for mandate in _mandates:
+            if mandate['details']['position'].startswith('MIN'):
+                mandate['details']['position'] = 'MIN'
+
+            try:
+                user.mandates[mandate['details']['position']] += 1
+            except KeyError:
+                user.mandates[mandate['details']['position']] = 1
+
+        for contrib in _contributions:
+            try:
+                user.contributions[contrib['action']] += 1
+            except KeyError:
+                user.contributions[contrib['action']] = 1
+
+        return user
+
+    def get_institutions(self) -> State:
+        """Récupère l'état actuel des institutions de la république."""
+
+        admin = Administration()
+        gov = Government(Official('0'))
+        assembly = Assembly()
+        court = Court()
+        police_forces = PoliceForces()
+
+        _get_position: list[dict] = lambda pos : self._select_from_db('functions', 'id', pos)[0]['users']
+
+        admin.members = [ self.get_official(user) for user in _get_position('ADMIN') ]
+        admin.president = self.get_official(0xF7DB60DD1C4300A) # happex (remplace Kheops pour l'instant)
+
+        gov.president = self.get_official(0x0)
+
+        minister = lambda code : self.get_official(_get_position(f'MIN_{code}')[0])
+        gov.prime_minister = minister('PRIM')
+        gov.economy_minister = minister('ECO')
+        gov.inner_minister = minister('INN')
+        gov.press_minister = minister('AUD')
+        gov.justice_minister = minister('JUS')
+        gov.outer_minister = minister('OUT')
+
+        assembly.president = self.get_official(_get_position('PRE_AS')[0])
+        assembly.members = [ self.get_official(user) for user in _get_position('REPR') ]
+
+        court.president = gov.justice_minister
+        court.members = [ self.get_official(user) for user in _get_position('JUDGE') ]
+
+        police_forces.president = gov.inner_minister
+        police_forces.members = [ self.get_official(user) for user in _get_position('POLICE') ]
+
+        instits = State()
+        instits.administration = admin
+        instits.government = gov
+        instits.court = court
+        instits.assembly = assembly
+        instits.police = police_forces
+
+        return instits
+
+    def update_institutions(self, institutions: State):
+        """
+        Fonction communément appelée après un vote législatif ou une nomination.\n
+        Celle-ci met à jour: Le gouvernement (président, ministres), les différents députés et leur président, les différents juges, les différents policiers.\n
+
+        ## Paramètres
+        institutions: `.State`\n
+            Le nouvel état des institutions, à sauvegarder.
+        """
+
+        get_ids = lambda institution : [ member.id for member in institutions.__getattribute__(institution).members ]
+
+        self._put_in_db('functions', { 'id': 'ADMIN', 'users': get_ids('administration') })
+        self._put_in_db('functions', { 'id': 'REPR', 'users': get_ids('assembly') })
+        self._put_in_db('functions', { 'id': 'JUDGE', 'users': get_ids('court') })
+        self._put_in_db('functions', { 'id': 'POLICE', 'users': get_ids('police') })
+
+        self._put_in_db('functions', { 'id': 'PRE_AS', 'users': [ institutions.assembly.president.id ] })
+        self._put_in_db('functions', { 'id': 'PRE_REP', 'users': [ institutions.government.president.id ] })
+
+        self._put_in_db('functions', { 'id': 'MIN_PRIM', 'users': [ institutions.government.prime_minister.id ] })
+        self._put_in_db('functions', { 'id': 'MIN_INN', 'users': [ institutions.government.inner_minister.id ] })
+        self._put_in_db('functions', { 'id': 'MIN_JUS', 'users': [ institutions.government.justice_minister.id ] })
+        self._put_in_db('functions', { 'id': 'MIN_ECO', 'users': [ institutions.government.economy_minister.id ] })
+        self._put_in_db('functions', { 'id': 'MIN_AUD', 'users': [ institutions.government.press_minister.id ] })
+        self._put_in_db('functions', { 'id': 'MIN_OUT', 'users': [ institutions.government.outer_minister.id ] })
+
+    def new_mandate(self, institutions: State, weeks: int = 4):
+        """
+        Fonction qui amène à supprimer toutes les archives du mandat précédent
+
+        ## Paramètres
+        - institutions: `.State`\n
+            Nouvel État à sauvegarder
+        - weeks: `int`\n
+            Nombre de semaines du mandat
+        """
+
+        for item in self.fetch('mandate'):
+            if item['date'] >= round(time.time()) - weeks * 604800: # On évite de supprimer les informations écrites lors de la période définie
+                self._delete_by_ID('mandate', item['id'])
+
+        self.update_institutions(institutions)
+
+    """
+    ---- ARCHIVES ----
+    """
+
+    def _add_archive(self, archive: Archive):
+        """
+        Ajoute une archive d'une action (élection, promotion, ou rétrogradation) dans la base de données.
+
+        ## Paramètres
+        - archive: `.Archive`\n
+            Archive à ajouter
+        """
+
+        archive.id = NSID(archive.id)
+        _data = archive.__dict__.copy()
+
+        if type(archive) == Election:
+            _data['_type'] = "election"
+        elif type(archive) == Promotion:
+            _data['_type'] = "promotion"
+        elif type(archive) == Demotion:
+            _data['_type'] = "demotion"
+        else:
+            _data['_type'] = "unknown"
+
+        self._put_in_db('archives', _data)
+        self._put_in_db('mandate', _data) # Ajouter les archives à celle du mandat actuel
+
+    def _get_archive(self, id: NSID) -> Archive | Election | Promotion | Demotion:
+        """
+        Récupère une archive spécifique.
+
+        ## Paramètres
+        id: `NSID`\n
+            ID de l'archive.
+
+        ## Renvoie
+        - `.Archive | .Election | .Promotion | .Demotion`
+        """
+
+        id = NSID(id)
+        _data = self._get_by_ID('archives', id)
+
+        if _data is None:
+            return None
+
+        if _data['_type'] == "election":
+            archive = Election(_data['author'], _data['target'], _data['details']['position'])
+        elif _data['_type'] == "promotion":
+            archive = Promotion(_data['author'], _data['target'], _data['details']['position'])
+        elif _data['_type'] == "demotion":
+            archive = Demotion(_data['author'], _data['target'])
+        else:
+            archive = Archive(_data['author'], _data['target'])
+
+        archive.id = id
+        archive.action = _data['action']
+        archive.date = _data['date']
+        archive.details = _data['details']
+
+        return archive
+
+    def _fetch_archives(self, **query) -> list[ Archive | Election | Promotion | Demotion ]:
+        """
+        Récupère une liste d'archives correspondant à la requête.
+
+        ## Paramètres
+        query: `dict`\n
+            Requête pour filtrer les archives.
+
+        ## Renvoie
+        - `list[.Archive | .Election | .Promotion | .Demotion]`
+        """
+
+        _res = self.fetch('archives', **query)
+        
+        return [ self._get_archive(archive['id']) for archive in _res ]

nsarchive/utils.py

@@ -0,0 +1,26 @@
+import io
+import math
+import os
+from PIL import Image
+
+def open_asset(path: str) -> bytes:
+    curr_dir = os.path.dirname(os.path.abspath(os.path.join(__file__)))
+    asset_path = os.path.join(curr_dir, 'assets', path)
+
+    image = Image.open(asset_path)
+    val = io.BytesIO()
+
+    image.save(val, format = 'PNG')
+
+    return val.getvalue()
+
+def compress_image(data: bytes, _max: int = 1000 ** 2) -> bytes:
+    img = Image.open(io.BytesIO(data))
+    size = 2 * ( math.floor(math.sqrt(_max),) )
+
+    img.resize(size)
+
+    val = io.BytesIO()
+    img.save(val)
+
+    return val.getvalue()

nsarchive-2.0.0.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: nsarchive
+Version: 2.0.0
+Summary: API-wrapper pour récupérer des données liées à Nation
+License: GPL-3.0
+Author: happex
+Author-email: 110610727+okayhappex@users.noreply.github.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pillow (>=10.4,<11.0)
+Requires-Dist: supabase (>=2.9.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# NSArchive
+
+Documentation pas disponible pour l'instant

nsarchive-2.0.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+nsarchive/__init__.py,sha256=_hwIocDyD7R-4rS7ypca8jZex93H6mK-b9NpTpt-Rvo,724
+nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
+nsarchive/cls/archives.py,sha256=3vyGOBZUE-B-G_QMJXRIPD0d-1O5z4wqv-2MRf5AQdA,2506
+nsarchive/cls/base.py,sha256=7gbXtKZaqkr8NWf-0oZaZ0alR9JSx_G1Qf7Sbn-MbF0,5611
+nsarchive/cls/economy.py,sha256=soe3ATrtQem-u80vz8nXfsn_3TqMdhpolyTxRenH2C0,2742
+nsarchive/cls/entities.py,sha256=fAxn4V64dqoB1wq7t-kByARlrr_jKzPzqpvFO_ECXnI,10144
+nsarchive/cls/exceptions.py,sha256=QN6Qn7cxTkGoC4lO50hBAq4gZCgo7scQvCkb-xKl6Xs,692
+nsarchive/cls/republic.py,sha256=16NFNCkJxOeVRd6BoJ68AlrTESQgRfZ5FSFlNWTEdK0,4103
+nsarchive/instances/_economy.py,sha256=trReX8u5QrgcYm6RElV-gNjVyFbZWO783XTDMm9JJj4,7777
+nsarchive/instances/_entities.py,sha256=AmpnXz1penQz09bhnErK8QKU6WnVwGwc3txkHc-OFfY,10635
+nsarchive/instances/_republic.py,sha256=5cOihYch6n2dyYAqiNYMdwerwcyZ9Y80f5cRtvkiH-o,11289
+nsarchive/utils.py,sha256=qpQCZLlbVApOLtCI2ml54QwUld6K8fDxyBfwzofqXzw,610
+nsarchive-2.0.0.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
+nsarchive-2.0.0.dist-info/METADATA,sha256=MYuiI2Ga-zKQPWApI69ORP0JiXYDoWyRNu9utwP1Q8s,696
+nsarchive-2.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+nsarchive-2.0.0.dist-info/RECORD,,

nsarchive/utils/assets.py

@@ -1,15 +0,0 @@
-import io
-import os
-from PIL import Image
-
-def open(path: str) -> Image:
-    curr_dir = os.path.dirname(os.path.abspath(os.path.join(__file__)))
-    parent_dir = os.path.dirname(curr_dir)
-    asset_path = os.path.join(parent_dir, 'assets', path)
-
-    image = Image.open(asset_path)
-    val = io.BytesIO()
-
-    image.save(val, format = 'PNG')
-
-    return val.getvalue()

nsarchive-1.3.0.dist-info/METADATA

@@ -1,177 +0,0 @@
-Metadata-Version: 2.1
-Name: nsarchive
-Version: 1.3.0
-Summary: 
-License: GPL-3.0
-Author: happex
-Author-email: 110610727+okayhappex@users.noreply.github.com
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: deta (>=1.2,<2.0)
-Requires-Dist: pillow (>=10.4,<11.0)
-Description-Content-Type: text/markdown
-
-# nsarchive
-
-`nsarchive` est un module Python pour la gestion des entités (utilisateurs et organisations) à l'aide de la base de données Deta. Ce module permet de créer, récupérer, sauvegarder et gérer des entités et leurs attributs spécifiques.
-
-## Pré-requis
-
-Listes des choses à avoir afin de pouvoir utiliser le module correctement:
-- [Python 3.10](https://www.python.org/downloads/) ou supérieur
-- Un token [Deta](https://deta.space), donné par un administrateur ou pour votre collection personnelle
-- Un bon capuccino, pour commencer la programmation en bons termes
-
-> **Note:** Il vous faudra un token différent pour accéder aux différentes parties de la base de données. Vos tokens n'expireront pas à moins que l'ordre en aura été donné
-
-## Installation
-
-Vous pouvez installer ce module via pip :
-
-```sh
-pip install nsarchive
-```
-
-## Utilisation
-
-### Importation et Initialisation
-
-Pour utiliser `nsarchive`, commencez par importer le module et initialiser une instance d'`EntityInstance` avec votre token Deta.
-
-```python
-from nsarchive import EntityInstance
-
-# Remplacez 'your_deta_token' par votre véritable token Deta
-entity_instance = EntityInstance(token = 'your_deta_token')
-```
-
-### Récupérer une Entité
-
-Vous pouvez récupérer une entité (Utilisateur ou Organisation) à l'aide de son ID.
-
-```python
-entity = entity_instance.get_entity(id = 'entity_id')
-print(entity.name)
-```
-
-**ATTENTION: Les entités sont identifiées sous une forme hexadécimale. Pour les avoir, vous devez convertir leur ID Discord en hexadécimale puis enlever le préfixe `0x`.**
-
-Pour les organisations, l'ID Discord correspondra à la formule suivante: `ID fondateur // 100000`.
-
-N'oubliez pas de toujours utiliser un `str` dans les ID pour interagir avec la base de données.
-
-### Sauvegarder une Entité
-
-Après avoir modifié une entité, vous pouvez la sauvegarder dans la base de données.
-
-```python
-entity.rename("Nouveau Nom")
-entity_instance.save_entity(entity)
-```
-
-### Rechercher des Entités
-
-Vous pouvez rechercher des entités avec des critères spécifiques.
-
-```python
-entities = entity_instance.fetch_entity(query = {'name': 'Alice'})
-for entity in entities:
-    print(entity['name'])
-```
-
-### Gérer les Organisations
-
-Les organisations peuvent avoir des membres et des certifications. Voici comment ajouter un membre ou une certification.
-
-```python
-organization = entity_instance.get_entity(id = 'org_id')
-user = entity_instance.get_entity(id = 'user_id')
-
-# Ajouter un membre
-organization.add_member(user)
-entity_instance.save_entity(organization)
-
-# Ajouter une certification
-organization.add_certification('Certification Example')
-entity_instance.save_entity(organization)
-```
-
-Les certifications pourront être utilisées pour vérifier l'officialité d'une organisation, mais également pour déterminer si l'on peut accorder (ou non) des permissions à ses membres.
-
-### Exemples de Classes
-
-#### `Entity`
-
-Classe parente des classes `User` et `Organization`, elle est utilisée lorsque le module ne peut pas déterminer l'appartenance d'une identité à l'une de ces deux classes ou à l'autre.
-
-```python
-from nsarchive.cls.entities import Entity
-
-entity = Entity(id='entity_id')
-entity.rename('New Name')
-entity.add_xp(100)
-print(entity.get_level())
-```
-
-#### `User`
-
-```python
-from nsarchive.cls.entities import User
-
-user = User(id = 'user_id')
-user.edit_boost(name = 'admin', multiplier = 5) # Négliger le paramètre <multiplier> ou le fixer à un nombre négatif reviendrait à supprimer le boost.
-print(user.boosts)
-```
-
-> **Note:** Lorsqu'on ajoute de l'expérience à un utilisateur via la méthode `add_xp`, le nombre de points ajoutés est automatiquement multiplié par le bonus le plus important dont l'utilisateur bénéficie.
-
-#### `Organization`
-
-```python
-from nsarchive.cls.entities import Organization
-
-organization = Organization(id = 'org_id')
-organization.set_owner(user)
-organization.add_member(user)
-print(organization.members)
-```
-
-> **Note:** Les attributs `owner` et `members` sont indépendants. L'owner peut être n'importe quelle personne faisant ou non partie des `members`.
-
-## Gestion des Exceptions
-
-`nsarchive` fournit des exceptions spécifiques pour gérer les erreurs courantes.
-
-#### `NameTooLongError`
-
-Lancé lorsque le nom d'une entité dépasse la longueur maximale autorisée (32 caractères).
-
-```python
-from nsarchive.cls.exceptions import NameTooLongError
-
-try:
-    entity.rename('Ce nom est long, voire même très long, je dirais même extrêmement long')
-except NameTooLongError as e:
-    print(e)
-```
-
-#### `EntityTypeError`
-
-Lancé lorsque le type d'entité est incorrect. Vous ne devriez normalement pas la rencontrer en utilisant le module, mais elle pourrait vous être utile.
-
-```python
-from nsarchive.cls.exceptions import EntityTypeError
-
-try:
-    # Code qui peut lancer une EntityTypeError
-except EntityTypeError as e:
-    print(e)
-```
-
-## License
-
-Ce projet est sous licence GNU GPL-3.0 - Voir le fichier [LICENSE](LICENSE) pour plus de détails.

nsarchive-1.3.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-nsarchive/__init__.py,sha256=idTG-9WiUJZ6rkkRXwjBvt_lC-lOKyz6eSS22vSMi3k,27011
-nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
-nsarchive/cls/archives.py,sha256=i4R7NPYXX_1oi0oLAvL_4SqyjqPutXSXKysUetE6hME,2001
-nsarchive/cls/base.py,sha256=DGDm0uD96M00-qvdKsltU9kAfAOBr85Ov0b18gTnoIM,714
-nsarchive/cls/economy.py,sha256=JpNB06JHek4uUapdk89-SR3DEoSyxXPn8OqZJkOZH_E,1252
-nsarchive/cls/entities.py,sha256=Rvu2Q1mTWqQ-z92j-OXhoXSWked7p4tOCJm0gIlnP9c,6179
-nsarchive/cls/exceptions.py,sha256=QN6Qn7cxTkGoC4lO50hBAq4gZCgo7scQvCkb-xKl6Xs,692
-nsarchive/cls/republic.py,sha256=6eut6OsFoOm9TVhA41fM3NlMEA3Uhg9TCuXgl46vFko,1985
-nsarchive/utils/assets.py,sha256=hd0STSpa0yT-OJlUyI_wCYXJqcBiUMQds2pZTXNNg9c,382
-nsarchive-1.3.0.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
-nsarchive-1.3.0.dist-info/METADATA,sha256=kndn-qxF_P0cYEo92vaKArA1Vpgn35ao_y7poWqQFo8,5629
-nsarchive-1.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-nsarchive-1.3.0.dist-info/RECORD,,