nsarchive 0.1a0__tar.gz → 0.2a0__tar.gz

nsarchive-0.2a0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.1
+Name: nsarchive
+Version: 0.2a0
+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
+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(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-0.2a0/README.md

@@ -0,0 +1,160 @@
+# 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(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-0.2a0/nsarchive/__init__.py

@@ -0,0 +1,138 @@
+import time
+
+import deta
+
+from .cls.entities import *
+from .cls.votes import *
+
+from .cls.exceptions import *
+
+class EntityInstance:
+    def __init__(self, token: str) -> None:
+        self.db = deta.Deta(token)
+        self.base = self.db.Base('entities')
+        self.electors = self.db.Base('electors')
+
+    def get_entity(self, id: str) -> User | Organization | Entity:
+        id = id.upper()
+        _data = self.base.get(id)
+
+        if _data is None:
+            return Entity("0")
+
+        if _data['_type'] == 'user':
+            entity = User(id)
+        elif _data['_type'] == 'organization':
+            entity = Organization(id)
+        else:
+            entity = Entity(id)
+
+        entity.name = _data['name']
+        entity.legalPosition = _data['legalPosition'] # Métier si c'est un utilisateur, domaine professionnel si c'est un collectif
+        entity.registerDate = _data['registerDate']
+        entity.xp = _data['xp']
+
+        if type(entity) == Organization:
+            entity.owner = self.get_entity(_data['owner_id'].upper())
+            entity.members = [
+                self.get_entity(_id) for _id in _data['members']
+            ]
+
+            entity.certifications = _data['certifications']
+        elif type(entity) == User:
+            entity.boosts = _data['boosts']
+        
+        return entity
+
+    def save_entity(self, entity: Entity) -> None:
+        _base = self.base
+        _data = {
+            '_type': 'user' if type(entity) == User else 'organization' if type(entity) == Organization else 'unknown',
+            'name': entity.name,
+            'legalPosition': entity.legalPosition,
+            'registerDate': entity.registerDate,
+            'xp': entity.xp
+        }
+
+        if type(entity) == Organization:
+            _data['owner_id'] = entity.owner.id.upper() if entity.owner else Entity("0")
+            _data['members'] = [ member.id.upper() for member in entity.members ] if entity.members else []
+            _data['certifications'] = entity.certifications
+        elif type(entity) == User:
+            _data['boosts'] = entity.boosts
+
+        _base.put(_data, entity.id.upper(), expire_in = 3 * 31536000) # Données supprimées tous les trois ans
+
+    def get_elector(self, id: str) -> Elector:
+        id = id.upper()
+        _data = self.electors.get(id)
+
+        if _data is None:
+            return Elector('0')
+        
+        elector = Elector(id)
+        elector.votes = _data['votes']
+        
+        return elector
+
+    def save_elector(self, elector: Elector):
+        _data = {
+            "votes": elector.votes
+        }
+
+        self.electors.put(_data, elector.id.upper())
+
+    def fetch(self, query = None, listquery: dict | None = None) -> list:
+        _res = self.base.fetch(query).items
+
+        if listquery is not None:
+            for item in _res:
+                for target, value in listquery:
+                    if value not in item[target]:
+                        _res.remove(item)
+        
+        return _res
+
+    def get_entity_groups(self, id: int) -> list[Organization]:
+        groups = self.fetch({'_type': 'organization'}, {'members': str(id)})
+        
+        return [ self.get_entity(int(group['id'], 16)) for group in groups ]
+
+class RepublicInstance:
+    def __init__(self, token: str) -> None:
+        self.db = deta.Deta(token)
+        self.votes = self.db.Base('votes')
+
+    def get_vote(self, id: str) -> Vote | ClosedVote:
+        id = id.upper()
+        _data = self.votes.get(id)
+
+        if _data is None:
+            return None
+        
+        if _data['_type'] == 'open':
+            vote = Vote(id, _data['title'], tuple(_data['choices'].keys()))
+        elif _data['_type'] == 'closed':
+            vote = ClosedVote(id, _data['title'])
+        else:
+            vote = Vote('0', 'Unknown Vote', ())
+        
+        vote.author = _data['author']
+        vote.startDate = _data['startDate']
+        vote.endDate = _data['endDate']
+        vote.choices = _data['choices']
+        
+        return vote
+
+    def save_vote(self, vote: Vote | ClosedVote):
+        _base = self.base
+        _data = {
+            '_type': 'open' if type(vote) == Vote else 'closed' if type(vote) == ClosedVote else 'unknown',
+            'title': vote.title,
+            'author': vote.author,
+            'startDate': vote.startDate,
+            'endDate': vote.endDate,
+            'choices': vote.choices
+        }
+
+        _base.put(_data, vote.id.upper())

{nsarchive-0.1a0 → nsarchive-0.2a0}/nsarchive/cls/entities.py

@@ -62,4 +62,29 @@ class Organization(Entity):
             self.members.remove(member)
     
     def set_owner(self, member: User) -> None:
-        self.owner = member
+        self.owner = member
+
+class Elector(User):
+    def __init__(self, id: str) -> None:
+        self.id: str = id
+        self.votes: list[str] = []
+
+class FunctionalUser(User):
+    def __init__(self, id: str):
+        super().__init__(id)
+
+        self.permissions: dict = {
+            'approve_project': False,
+            'create_org': False,
+            'destroy_gov': False,
+            'destroy_org': False,
+            'propose_projects': False
+        }
+
+        self.mandates: int = 0
+        self.contribs: dict = {
+            'projects': 0,
+            'approved_projects': 0, 
+            'admin_actions': 0, 
+            'law_votes': 0
+        }

nsarchive-0.2a0/nsarchive/cls/votes.py

@@ -0,0 +1,16 @@
+import time
+
+from .entities import FunctionalUser
+
+class Vote:
+    def __init__(self, id: str, title: str, choices: tuple[str]) -> None:
+        self.id: str = id
+        self.title: str = title
+        self.choices = { choice : 0 for choice in choices }
+        self.author: FunctionalUser
+        self.startDate: int = 0
+        self.endDate: int = 0
+
+class ClosedVote(Vote):
+    def __init__(self, id: str, title: str) -> None:
+        super().__init__(id, title, ('yes', 'no', 'blank'))

{nsarchive-0.1a0 → nsarchive-0.2a0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nsarchive"
-version = "0.1-alpha.0"
+version = "0.2-alpha.0"
 description = ""
 authors = ["happex <110610727+okayhappex@users.noreply.github.com>"]
 license = "GPL-3.0"

nsarchive-0.1a0/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: nsarchive
-Version: 0.1a0
-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
-Description-Content-Type: text/markdown
-
-# 1ns-archive
-

nsarchive-0.1a0/README.md

@@ -1 +0,0 @@
-# 1ns-archive

nsarchive-0.1a0/nsarchive/__init__.py

@@ -1,77 +0,0 @@
-import time
-
-import deta
-
-from .cls.entities import *
-from .cls.exceptions import *
-
-class EntityInstance:
-    def __init__(self, token: str) -> None:
-        self.db = deta.Deta(token)
-        self.base = self.db.Base('entities')
-
-    def get_entity(self, id: str) -> User | Organization | Entity:
-        _base = self.base
-        _data = _base.get(id)
-
-        if _data is None:
-            return Entity("0")
-
-        if _data['_type'] == 'user':
-            entity = User(id)
-        elif _data['_type'] == 'organization':
-            entity = Organization(id)
-        else:
-            entity = Entity(id)
-
-        entity.name = _data['name']
-        entity.legalPosition = _data['legalPosition'] # Métier si c'est un utilisateur, domaine professionnel si c'est un collectif
-        entity.registerDate = _data['registerDate']
-        entity.xp = _data['xp']
-
-        if type(entity) == Organization:
-            entity.owner = self.get_entity(_data['owner_id'])
-            entity.members = [
-                self.get_entity(_id) for _id in _data['members']
-            ]
-
-            entity.certifications = _data['certifications']
-        elif type(entity) == User:
-            entity.boosts = _data['boosts']
-        
-        return entity
-    
-    def save_entity(self, entity: Entity) -> None:
-        _base = self.base
-        _data = {
-            '_type': 'user' if type(entity) == User else 'organization' if type(entity) == Organization else 'unknown',
-            'name': entity.name,
-            'legalPosition': entity.legalPosition,
-            'registerDate': entity.registerDate,
-            'xp': entity.xp
-        }
-
-        if type(entity) == Organization:
-            _data['owner_id'] = entity.owner.id if entity.owner else Entity(0)
-            _data['members'] = [ member.id for member in entity.members ] if entity.members else []
-            _data['certifications'] = entity.certifications
-        elif type(entity) == User:
-            _data['boosts'] = entity.boosts
-
-        _base.put(_data, entity.id, expire_in = 3 * 31536000) # Données supprimées tous les trois ans
-
-    def fetch(self, query = None, listquery: dict | None = None) -> list:
-        _res = self.base.fetch(query).items
-
-        if listquery is not None:
-            for item in _res:
-                for target, value in listquery:
-                    if value not in item[target]:
-                        _res.remove(item)
-        
-        return _res
-    
-    def get_entity_groups(self, id: int) -> list[Organization]:
-        groups = self.fetch({'_type': 'organization'}, {'members': str(id)})
-        
-        return [ self.get_entity(int(group['id'], 16)) for group in groups ]

nsarchive-0.1a0/nsarchive/cls/votes.py

@@ -1,7 +0,0 @@
-import time
-
-class Vote:
-    def __init__(self, id: int, title: str, choices: list[str]) -> None:
-        self.id: int = id
-        self.title: str = title
-        self.choices = { choice : 0 for choice in choices }