nsarchive 2.0.0b1__tar.gz → 3.0.0a1__tar.gz

nsarchive-3.0.0a1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: nsarchive
+Version: 3.0.0a1
+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-3.0.0a1/README.md

@@ -0,0 +1,3 @@
+# NSArchive
+
+Documentation pas disponible pour l'instant

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/cls/archives.py

@@ -3,7 +3,24 @@ import time
 from .base import *
 
 class Archive:
-    def __init__(self, author: str | NSID = '0', target: str | NSID = '0') -> None:
+    def __init__(self, author: NSID = '0', target: NSID = '0'):
+        """
+        Classe de référence pour toutes les archives.
+
+        ## Attributs de base
+        - date: `int`\n
+            Date (timestamp) de l'exécution de l'archive
+        - id: `NSID`\n
+            Clé d'identification des archives (basée sur la date)
+        - author: `NSID`\n
+            ID de l'auteur de l'action
+        - target: `NSID`:
+            ID de la cible de l'action
+        - action: `str`:\n
+            Action effectuée
+        - details: `dict`\n
+            Ensemble de détails que les différents bots peuvent utiliser
+        """
         self.date: int = round(time.time())
 
         self.id: NSID = NSID(self.date)
@@ -19,7 +36,7 @@ class Archive:
 # Entities
 
 class Sanction(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details: dict = {
@@ -29,7 +46,7 @@ class Sanction(Archive):
         }
 
 class Report(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details: dict = {
@@ -41,7 +58,7 @@ class Report(Archive):
 # Community
 
 class Election(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
+    def __init__(self, author: NSID, target: NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.details = {
@@ -51,7 +68,7 @@ class Election(Archive):
         }
 
 class Promotion(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
+    def __init__(self, author: NSID, target: NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.details = {
@@ -59,14 +76,14 @@ class Promotion(Archive):
         }
 
 class Demotion(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
 
 # Bank
 
 class Transaction(Archive):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
+    def __init__(self, author: NSID, target: NSID) -> None:
         super().__init__(author, target)
 
         self.details = {

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/cls/base.py

@@ -4,6 +4,11 @@ import typing
 from supabase import Client
 
 class NSID(str):
+    """
+    Nation Server ID
+
+    ID unique et universel pour l'ensemble des entités et évènements. Il prend les `int`, les `str` et les autres instances `NSID` pour les convertir en un identifiant hexadécimal.
+    """
     unknown = "0"
     admin = "1"
     gov = "2"
@@ -35,6 +40,9 @@ class NSID(str):
         return instance
 
 class Instance:
+    """
+    Instance qui servira de base à toutes les instances.
+    """
     def __init__(self, client: Client):
         self.db = client
 

nsarchive-3.0.0a1/nsarchive/cls/economy.py

@@ -0,0 +1,100 @@
+from .base import NSID
+
+class BankAccount:
+    """
+    Compte en banque d'une entité, individuelle ou collective.
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant du compte
+    - owner: `NSID`\n
+        Identifiant du titulaire du compte
+    - amount: `int`\n
+        Somme d'argent totale sur le compte
+    - frozen: `bool`\n
+        État gelé ou non du compte
+    - bank: `NSID`\n
+        Identifiant de la banque qui détient le compte
+    - income: `int`\n
+        Somme entrante sur le compte depuis la dernière réinitialisation (tous les ~ 28 jours)
+    """
+
+    def __init__(self, id: NSID) -> None:
+        self.id: NSID = NSID(id)
+        self.owner: NSID = NSID(0)
+        self.amount: int = 0
+        self.frozen: bool = False
+        self.bank: NSID = NSID("6")
+
+        self.income: int = 0
+
+class Item:
+    """
+    Article d'inventaire qui peut circuler sur le serveur
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de l'objet
+    - title: `str`\n
+        Nom de l'objet
+    - emoji: `str`\n
+        Emoji lié à l'objet
+    """
+
+    def __init__(self, id: NSID) -> None:
+        self.id: NSID = NSID(id)
+        self.title: str = "Unknown Object"
+        self.emoji: str = ":light_bulb:"
+
+class Inventory:
+    """
+    Inventaire d'un membre
+
+    ## Attributs
+    - owner_id: `NSID`\n
+        ID du propriétaire de l'inventaire
+    - objects: `dict[str, NSID]`\n
+        Collection d'objets et leur quantité
+    """
+
+    def __init__(self, owner_id: NSID) -> None:
+        self.owner_id: NSID = NSID(owner_id)
+        self.objects: dict[str, NSID] = {}
+
+    def append(self, item: Item, quantity: int = 1):
+        if item.id in self.objects.keys():
+            self.objects[item.id] += quantity
+        else:
+            self.objects[item.id] = quantity
+
+    def throw(self, item: Item, quantity: int = 1):
+        if item.id in self.objects.keys():
+            if self.objects[item.id] > quantity:
+                self.objects[item.id] -= quantity
+            else:
+                self.objects[item.id] = 0
+
+class Sale:
+    """
+    Vente mettant en jeu un objet
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de la vente
+    - item: `NSID`\n
+        Identifiant de l'objet mis en vente
+    - quantity: `int`\n
+        Quantité d'objets mis en vente
+    - price: `int`\n
+        Prix total du lot
+    - seller_id: `NSID`\n
+        Identifiant du vendeur
+    """
+
+    def __init__(self, id: NSID, item: Item) -> None:
+        self.id: NSID = NSID(id)
+        self.item: NSID = NSID(item.id)
+        self.quantity: int = 1
+
+        self.price: int = 0
+        self.seller_id: NSID = NSID('0')

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/cls/entities.py

@@ -33,6 +33,18 @@ class PositionPermissions:
             self.__setattr__(*perm)
 
 class Position:
+    """
+    Position légale d'une entité
+
+    ## Attributs
+    - name: `str`\n
+        Titre de la position
+    - id: `str`\n
+        Identifiant de la position
+    - permissions: `.PositionPermissions`\n
+        Permissions accordées à l'utilisateur
+    """
+
     def __init__(self, id: str = 'inconnu') -> None:
         self.name: str = "Inconnue"
         self.id = id
@@ -42,7 +54,23 @@ class Position:
         return self.id
 
 class Entity:
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Classe de référence pour les entités
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant de l'entité
+    - name: `str`\n
+        Nom d'usage de l'entité
+    - registerDate: `int`\n
+        Date d'enregistrement de l'entité
+    - position: `.Position`\n
+        Position légale de l'entité
+    - additional: `dict`\n
+        Infos supplémentaires exploitables par les bots
+    """
+
+    def __init__(self, id: NSID) -> None:
         self.id: NSID = NSID(id) # ID hexadécimal de l'entité (ou nom dans le cas de l'entreprise)
         self.name: str = "Entité Inconnue"
         self.registerDate: int = 0
@@ -66,7 +94,22 @@ class Entity:
         del self.additional[key]
 
 class User(Entity):
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Entité individuelle
+
+    ## Attributs
+    - Tous les attributs de la classe `.Entity`
+    - xp: `int`\n
+        Points d'expérience de l'entité
+    - boosts: `dict[str, int]`\n
+        Ensemble des boosts dont bénéficie l'entité
+    - permissions: `.PositionPermissions`\n
+        Fusion des permissions offertes par la position et les groupes
+    - votes: `list[NSID]`\n
+        Liste des votes auxquels a participé l'entité
+    """
+
+    def __init__(self, id: NSID) -> None:
         super().__init__(NSID(id))
 
         self.xp: int = 0
@@ -74,7 +117,7 @@ class User(Entity):
         self.permissions: PositionPermissions = PositionPermissions() # Elles seront définies en récupérant les permissions de sa position
         self.votes: list[str] = []
 
-    def add_vote(self, id: str | NSID):
+    def add_vote(self, id: NSID):
         self.votes.append(NSID(id))
 
     def get_level(self) -> None:
@@ -111,7 +154,16 @@ class MemberPermissions:
             self.__setattr__(*perm)
 
 class GroupMember(User):
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Membre au sein d'une entité collective
+
+    ## Attributs
+    - Tous les attributs de la classe `.User`
+    - permission_level: `int`\n
+        Niveau d'accréditation du membre (0 = salarié, 4 = administrateur)
+    """
+
+    def __init__(self, id: NSID) -> None:
         super().__init__(id)
 
         self.permission_level: int = 0
@@ -133,19 +185,65 @@ class GroupMember(User):
 
         return p
 
+class Share:
+    """
+    Action d'une entreprise
+
+    ## Attributs
+    - owner: `NSID`\n
+        Identifiant du titulaire de l'action
+    - price: `int`\n
+        Prix de l'action
+    """
+
+    def __getstate__(self) -> dict:
+        return {
+            "owner": self.owner,
+            "price": self.price
+        }
+
+    def __setstate__(self, state: dict):
+        self.owner: NSID = state['owner']
+        self.price: int = state['price']
+
+    def __init__(self, owner: NSID = NSID(0x0), price: int = 10):
+        self.owner: NSID = owner
+        self.price: int = price
+
+    def assign_owner(self, owner: NSID):
+        self.owner = owner
+
+    def set_price(self, price: int):
+        self.price = price
+
 class Organization(Entity):
-    def __init__(self, id: str | NSID) -> None:
+    """
+    Entité collective
+
+    ## Attributs
+    - Tous les attributs de la classe `.Entity`
+    - owner: `.Entity`\n
+        Utilisateur ou entreprise propriétaire de l'entité collective
+    - avatar: `bytes`\n
+        Avatar/logo de l'entité collective
+    - certifications: `dict[str, int]`\n
+        Liste des certifications et de leur date d'ajout
+    - members: `list[.GroupMember]`\n
+        Liste des membres de l'entreprise
+    - parts: `list[.Share]`\n
+        Liste des actions émises par l'entreprise
+    """
+
+    def __init__(self, id: NSID) -> None:
         super().__init__(NSID(id))
 
-        self.owner: Entity
+        self.owner: Entity = User(NSID(0x0))
         self.avatar: bytes = utils.open_asset('default_avatar.png')
 
         self.certifications: dict = {}
         self.members: list[GroupMember] = []
 
-        self.parts: dict[NSID, int] = {
-            self.id: 1
-        }
+        self.parts: list[Share] = 50 * [ Share(self.owner.id, 0) ]
 
     def add_certification(self, certification: str) -> None:
         self.certifications[certification] = round(time.time())
@@ -176,5 +274,26 @@ class Organization(Entity):
     def set_owner(self, member: User) -> None:
         self.owner = member
 
-    def get_member_id(self) -> list[str]:
-        return [ member.id for member in self.members ]
+    def get_members_by_attr(self, attribute: str = "id") -> list[str]:
+        return [ member.__getattribute__(attribute) for member in self.members ]
+
+    def get_shares(self, include_worth: bool = False) -> dict[str, int] | dict[str, dict[str, int]]:
+        shares = {}
+
+        for share in self.parts:
+            if include_worth:
+                if share.owner in shares.keys():
+                    shares[share.owner]['count'] += 1
+                    shares[share.owner]['worth'] += share.price
+                else:
+                    shares[share.owner] = {
+                        'count': 1,
+                        'worth': share.price
+                    }
+            else:
+                if share.owner in shares.keys():
+                    shares[share.owner] += 1
+                else:
+                    shares[share.owner] = 1
+
+        return shares

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/cls/republic.py

@@ -3,13 +3,43 @@ from nsarchive.cls.base import NSID
 # Votes
 
 class VoteOption:
+    """
+    Option disponible lors d'un vote
+
+    ## Attributs
+    - id: `str`\n
+        Identifiant de l'option
+    - title: `str`\n
+        Label de l'option
+    - count: `int`\n
+        Nombre de sympathisants pour cette option
+    """
+
     def __init__(self, id: str, title: str = None, count: int = 0):
         self.id = id
         self.title = title if title else id
         self.count = count
 
 class Vote:
-    def __init__(self, id: str | NSID, title: str) -> None:
+    """
+    Classe de référence pour les différents votes du serveur
+
+    ## Attributs
+    - id: `NSID`\n
+        Identifiant du vote
+    - title: `str`\n
+        Titre du vote
+    - choices: list[.VoteOption]\n
+        Liste des choix disponibles
+    - author: `NSID`\n
+        Identifiant de l'auteur du vote
+    - startDate: `int`\n
+        Date de début du vote
+    - endDate: `int`\n
+        Date limite pour voter
+    """
+
+    def __init__(self, id: NSID, title: str) -> None:
         self.id: NSID = NSID(id)
         self.title: str = title
         self.choices: list[VoteOption] = []
@@ -31,6 +61,10 @@ class Vote:
             return sorted_list
 
 class Referendum(Vote):
+    """
+    Vote à trois positions
+    """
+
     def __init__(self, id: NSID, title: str) -> None:
         super().__init__(id, title)
 
@@ -41,6 +75,10 @@ class Referendum(Vote):
         ]
 
 class Lawsuit(Vote):
+    """
+    Vote à trois positions pour un procès
+    """
+
     def __init__(self, id: NSID, title: str) -> None:
         super().__init__(id, title)
 
@@ -54,7 +92,7 @@ class Lawsuit(Vote):
 # Institutions (defs)
 
 class Official:
-    def __init__(self, id: str | NSID) -> None:
+    def __init__(self, id: NSID) -> None:
         self.id: NSID = NSID(id)
 
         self.mandates: int = {

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/instances/_economy.py

@@ -18,12 +18,12 @@ class EconomyInstance(Instance):
     ---- COMPTES EN BANQUE ----
     """
 
-    def get_account(self, id: str | NSID) -> BankAccount:
+    def get_account(self, id: NSID) -> BankAccount:
         """
         Récupère les informations d'un compte bancaire.
 
         ## Paramètres
-        id: `str | NSID`\n
+        id: `NSID`\n
             ID du compte.
 
         ## Renvoie
@@ -46,7 +46,13 @@ class EconomyInstance(Instance):
         return account
 
     def save_account(self, account: BankAccount):
-        """Sauvegarde un compte bancaire dans la base de données."""
+        """
+        Sauvegarde un compte bancaire dans la base de données.
+
+        ## Paramètres
+        - account: `.BankAccount`\n
+            Compte à sauvegarder
+        """
 
         _data = {
             'id': NSID(account.id),
@@ -60,7 +66,13 @@ class EconomyInstance(Instance):
         self._put_in_db('accounts', _data)
 
     def freeze_account(self, account: BankAccount):
-        """Gèle un compte bancaire pour empêcher toute transaction."""
+        """
+        Gèle un compte bancaire pour empêcher toute transaction.
+
+        ## Paramètres
+        - account: `.BankAccount`\n
+            Compte à geler
+        """
 
         account.id = NSID(account.id)
         account.frozen = True
@@ -71,7 +83,7 @@ class EconomyInstance(Instance):
     ---- OBJETS & VENTES ----
     """
 
-    def save_item(self, item: Item) -> None:
+    def save_item(self, item: Item):
         """
         Sauvegarde des infos à propos d'un item.
 
@@ -107,13 +119,13 @@ class EconomyInstance(Instance):
 
         return item
 
-    def delete_item(self, item: Item) -> None:
+    def delete_item(self, item: Item):
         """
         Annule le référencement d'un item.
 
         ## Paramètres
         item: `.Item`\n
-            Item à vendre
+            Item à supprimer
         """
 
         self._delete_by_ID('items', item.id)
@@ -127,7 +139,7 @@ class EconomyInstance(Instance):
             ID de la vente.
 
         ## Renvoie
-        - `.Sale | None`
+        - `.Sale | None`: Le résultat de la vente
         """
 
         id = NSID(id)
@@ -136,7 +148,7 @@ class EconomyInstance(Instance):
 
         if _data is None:
             return None
-        
+
         item = self.get_item(_data['id'])
 
         sale = Sale(NSID(id), Item(_data['id']) if item is None else item)
@@ -144,7 +156,7 @@ class EconomyInstance(Instance):
 
         return sale
 
-    def sell_item(self, item: Item, quantity: int, price: int, seller: NSID) -> None:
+    def sell_item(self, item: Item, quantity: int, price: int, seller: NSID):
         """
         Vend un item sur le marché.
 
@@ -187,7 +199,7 @@ class EconomyInstance(Instance):
             ID du propriétaire de l'inventaire
 
         ## Retourne
-        - `.Inventory | None`
+        - `.Inventory | None`: L'inventaire s'il a été trouvé
         """
 
         _data = self._get_by_ID('inventories', id)
@@ -204,7 +216,7 @@ class EconomyInstance(Instance):
 
         return inventory
 
-    def save_inventory(self, inventory: Inventory) -> None:
+    def save_inventory(self, inventory: Inventory):
         """
         Sauvegarder un inventaire
 
@@ -217,7 +229,7 @@ class EconomyInstance(Instance):
 
         self._put_in_db('inventories', _data)
 
-    def delete_inventory(self, inventory: Inventory) -> None:
+    def delete_inventory(self, inventory: Inventory):
         """
         Supprime un inventaire
 
@@ -233,7 +245,13 @@ class EconomyInstance(Instance):
     """
 
     def _add_archive(self, archive: Archive):
-        """Ajoute une archive d'une transaction ou d'une vente dans la base de données."""
+        """
+        Ajoute une archive d'une transaction ou d'une vente dans la base de données.
+
+        ## Paramètres
+        - archive: `.Archive`\n
+            Archive à ajouter
+        """
 
         archive.id = NSID(archive.id)
         archive.author = NSID(archive.author)
@@ -248,12 +266,12 @@ class EconomyInstance(Instance):
 
         self._put_in_db('archives', _data)
 
-    def _get_archive(self, id: str | NSID) -> Archive | Transaction:
+    def _get_archive(self, id: NSID) -> Archive | Transaction:
         """
         Récupère une archive spécifique.
 
         ## Paramètres
-        id: `str | NSID`\n
+        id: `NSID`\n
             ID de l'archive.
 
         ## Renvoie

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/instances/_entities.py

@@ -25,7 +25,7 @@ class EntityInstance(Instance):
     ---- ENTITÉS ----
     """
 
-    def get_entity(self, id: str | NSID) -> User | Organization | Entity:
+    def get_entity(self, id: NSID) -> User | Organization | Entity:
         """
         Fonction permettant de récupérer le profil public d'une entité.\n
 
@@ -83,8 +83,12 @@ class EntityInstance(Instance):
 
                 entity.append(member)
 
+            entity.parts = []
+
+            for owner, attrs in _data['parts'].items():
+                entity.parts.extend(attrs['count'] * [ Share(NSID(owner), attrs['worth'] // attrs['count']) ])
+
             entity.certifications = _data['certifications']
-            entity.parts = _data['parts']
             entity.avatar = self._download_from_storage('organizations', f"avatars/{entity.id}")
         else:
             entity = Entity(id)
@@ -101,12 +105,12 @@ class EntityInstance(Instance):
 
         return entity
 
-    def save_entity(self, entity: Entity) -> None:
+    def save_entity(self, entity: Entity):
         """
         Fonction permettant de créer ou modifier une entité.
 
         ## Paramètres
-        entity: `.Entity` ( `.User | .Organization` )
+        entity: `.Entity`\n
             L'entité à sauvegarder
         """
 
@@ -130,6 +134,7 @@ class EntityInstance(Instance):
             _data['owner_id'] = NSID(entity.owner.id) if entity.owner else NSID("0")
             _data['members'] = []
             _data['certifications'] = entity.certifications
+            _data['parts'] = entity.get_shares(True)
 
             for member in entity.members:
                 _member = {
@@ -139,7 +144,7 @@ class EntityInstance(Instance):
 
                 _data['members'] += [_member]
 
-            self._upload_to_storage('organizations', entity.avatar, f'/avatars/{entity.id}')
+            self._upload_to_storage('organizations', entity.avatar, f'/avatars/{entity.id}', overwrite = True)
         elif type(entity) == User:
             _data['xp'] = entity.xp
             _data['boosts'] = entity.boosts
@@ -147,12 +152,12 @@ class EntityInstance(Instance):
 
         self._put_in_db('individuals' if isinstance(entity, User) else 'organizations', _data)
 
-    def delete_entity(self, entity: Entity) -> None:
+    def delete_entity(self, entity: Entity):
         """
         Fonction permettant de supprimer le profil d'une entité
 
         ## Paramètres
-        entity: `.Entity` ( `.User | .Organization` )
+        entity: `.Entity`\n
             L'entité à supprimer
         """
 
@@ -163,11 +168,11 @@ class EntityInstance(Instance):
         Récupère une liste d'entités en fonction d'une requête.
 
         ## Paramètres
-        query: `dict`
+        query: `dict`\n
             La requête pour filtrer les entités.
 
         ## Renvoie
-        - `list[Entity | User | Organization]`
+        - `list[.Entity | .User | .Organization]`
         """
 
         if "_type" in query.keys():
@@ -187,43 +192,41 @@ class EntityInstance(Instance):
 
         return [ self.get_entity(NSID(entity['id'])) for entity in _res if entity is not None ]
 
-    def get_entity_groups(self, id: str | NSID) -> list[Organization]:
+    def get_entity_groups(self, id: NSID) -> list[Organization]:
         """
         Récupère les groupes auxquels appartient une entité.
 
         ## Paramètres
-        id: `str | NSID`
+        id: `NSID`\n
             ID de l'entité.
 
         ## Renvoie
-        - `list[Organization]`
+        - `list[.Organization]`
         """
 
         id = NSID(id)
-        groups = self.fetch_entities(_type = 'organization')
+        _groups = self.fetch_entities(_type = 'organization')
+        groups = []
 
-        for group in groups:
+        for group in _groups:
             if group is None:
-                groups.remove(group)
                 continue
 
             if group.owner.id == id:
-                continue
+                groups.append(group)
 
             for member in group.members:
                 if member.id == id:
-                    break
-            else:
-                groups.remove(group)
+                    groups.append(group)
 
-        return [ group for group in groups if group is not None ]
+        return [ group for group in groups ]
 
     def get_position(self, id: str) -> Position:
         """
         Récupère une position légale (métier, domaine professionnel).
 
         ## Paramètres
-        id: `str`
+        id: `str`\n
             ID de la position (SENSIBLE À LA CASSE !)
 
         ## Renvoie
@@ -245,9 +248,13 @@ class EntityInstance(Instance):
     ---- ARCHIVES --
     """
 
-    def _add_archive(self, archive: Archive) -> None:
+    def _add_archive(self, archive: Archive):
         """
         Ajoute une archive d'une action (modification au sein d'un groupe ou sanction) dans la base de données.
+
+        ## Paramètres
+        - archive: `.Archive`\n
+            Archive à ajouter
         """
 
         archive.id = NSID(archive.id)
@@ -265,12 +272,12 @@ class EntityInstance(Instance):
 
         self._put_in_db('archives', _data)
 
-    def _get_archive(self, id: str | NSID) -> Archive | Sanction:
+    def _get_archive(self, id: NSID) -> Archive | Sanction:
         """
         Récupère une archive spécifique.
 
         ## Paramètres
-        id: `str | NSID`
+        id: `NSID`\n
             ID de l'archive.
 
         ## Renvoie
@@ -302,7 +309,7 @@ class EntityInstance(Instance):
         Récupère une liste d'archives correspondant à la requête.
 
         ## Paramètres
-        query: `dict`
+        query: `dict`\n
             Requête pour filtrer les archives.
 
         ## Renvoie

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/nsarchive/instances/_republic.py

@@ -26,12 +26,12 @@ class RepublicInstance(Instance):
     ---- VOTES & REFERENDUMS ----
     """
 
-    def get_vote(self, id: str | NSID) -> Vote | Referendum | Lawsuit:
+    def get_vote(self, id: NSID) -> Vote | Referendum | Lawsuit:
         """
         Récupère un vote spécifique.
 
         ## Paramètres
-        id: `str | NSID`\n
+        id: `NSID`\n
             ID du vote.
 
         ## Renvoie
@@ -72,8 +72,14 @@ class RepublicInstance(Instance):
 
         return vote
 
-    def save_vote(self, vote: Vote | Referendum | Lawsuit) -> None:
-        """Sauvegarde un vote dans la base de données."""
+    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)
 
@@ -102,12 +108,12 @@ class RepublicInstance(Instance):
     ---- INSTITUTION & MANDAT ----
     """
 
-    def get_official(self, id: str | NSID, current_mandate: bool = True) -> Official:
+    def get_official(self, id: NSID, current_mandate: bool = True) -> Official:
         """
         Récupère les informations d'un fonctionnaire (mandats, contributions).
 
         ## Paramètres
-        id: `str | NSID`\n
+        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.
@@ -190,7 +196,7 @@ class RepublicInstance(Instance):
         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: `.Institutions`\n
+        institutions: `.State`\n
             Le nouvel état des institutions, à sauvegarder.
         """
 
@@ -211,9 +217,15 @@ class RepublicInstance(Instance):
         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) -> None:
+    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'):
@@ -226,8 +238,14 @@ class RepublicInstance(Instance):
     ---- ARCHIVES ----
     """
 
-    def _add_archive(self, archive: Archive) -> None:
-        """Ajoute une archive d'une action (élection, promotion, ou rétrogradation) dans la base de données."""
+    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()
@@ -244,12 +262,12 @@ class RepublicInstance(Instance):
         self._put_in_db('archives', _data)
         self._put_in_db('mandate', _data) # Ajouter les archives à celle du mandat actuel
 
-    def _get_archive(self, id: str | NSID) -> Archive | Election | Promotion | Demotion:
+    def _get_archive(self, id: NSID) -> Archive | Election | Promotion | Demotion:
         """
         Récupère une archive spécifique.
 
         ## Paramètres
-        id: `str | NSID`\n
+        id: `NSID`\n
             ID de l'archive.
 
         ## Renvoie
@@ -283,7 +301,7 @@ class RepublicInstance(Instance):
         Récupère une liste d'archives correspondant à la requête.
 
         ## Paramètres
-        query: `dict`
+        query: `dict`\n
             Requête pour filtrer les archives.
 
         ## Renvoie

{nsarchive-2.0.0b1 → nsarchive-3.0.0a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nsarchive"
-version = "2.0.0-beta.1"
+version = "3.0.0a1"
 description = "API-wrapper pour récupérer des données liées à Nation"
 authors = ["happex <110610727+okayhappex@users.noreply.github.com>"]
 license = "GPL-3.0"

nsarchive-2.0.0b1/PKG-INFO

@@ -1,177 +0,0 @@
-Metadata-Version: 2.1
-Name: nsarchive
-Version: 2.0.0b1
-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
-
-`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-2.0.0b1/README.md

@@ -1,160 +0,0 @@
-# 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-2.0.0b1/nsarchive/cls/economy.py

@@ -1,44 +0,0 @@
-from .base import NSID
-
-class BankAccount:
-    def __init__(self, id: str | NSID) -> None:
-        self.id: NSID = NSID(id)
-        self.owner: NSID = NSID(0)
-        self.amount: int = 0
-        self.frozen: bool = False
-        self.bank: str = "HexaBank"
-
-        self.income: int = 0
-
-class Item:
-    def __init__(self, id: str | NSID) -> None:
-        self.id: NSID = NSID(id)
-        self.title: str = "Unknown Object"
-        self.emoji: str = ":light_bulb:"
-
-class Inventory:
-    def __init__(self, owner_id: NSID) -> None:
-        self.owner_id: NSID = NSID(owner_id)
-        self.objects: dict[str, NSID] = {}
-
-    def append(self, item: Item, quantity: int = 1):
-        if item.id in self.objects.keys():
-            self.objects[item.id] += quantity
-        else:
-            self.objects[item.id] = quantity
-
-    def throw(self, item: Item, quantity: int = 1):
-        if item.id in self.objects.keys():
-            if self.objects[item.id] > quantity:
-                self.objects[item.id] -= quantity
-            else:
-                self.objects[item.id] = 0
-
-class Sale:
-    def __init__(self, id: NSID, item: Item) -> None:
-        self.id: NSID = NSID(id)
-        self.item: NSID = NSID(item.id)
-        self.quantity: int = 1
-
-        self.price: int = 0
-        self.seller_id: NSID = NSID('0')