InseeFrLab / InseeFrLab/diff-privacy-poc

Roadmap "qualité du code"

Open
#2 1 comment 0 reactions 1 assignee Claimed by @StuartBenoliel View on GitHub
Dominant language
Jupyter Notebook
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Checklist:
- [ ] Séparer le package Python (dossier `/package_name/`) du POC applicatif Shiny (dossiers `/poc_shiny/`)
- [ ] Ecrire un notebook de démo du package
- [ ] Ajouter des annotations de types à chaque fonction (tous les arguments + le type de retour)
```python
def f(a: str, b: MyClass) -> MyOtherClass:
...
```
- [ ] Ajouter une docstring minimale pour chaque classe et chaque fonction
```python
class MyClass:
"""Short description of the class.

Attributes:
attr1 (str): Description of attr1.
attr2 (MyOtherClass): Description of attr2.
"""

def add(self, x: int, y: int) -> int:
"""Add two numbers.

Args:
x (int): First number.
y (int): Second number.

Returns:
int: Sum of the two numbers.
"""
return x + y
```
- [ ] Créer pyproject.toml file ([pour inspiration](https://github.com/InseeFrLab/data-reconstructio-from-tiles/blob/main/pyproject.toml))
- Permet d'initialiser le projet avec `pip install .`
- permet de configurer l'outil `ruff` (mieux que `flake8`, d'ailleurs je te conseille de [désactiver cette extension dans tes vscode et la remplacer par `mypy`](https://github.com/InseeFrLab/data-reconstructio-from-tiles/blob/main/init-scripts/vscode-python.sh#L18-L19))
- [ ] Écrire un README avec, a minima :
- une courte description du projet
- les commandes nécessaires pour installer et faire tourner l'application
- [ ] Écrire un script de lancement Onyxia (permet de *showcase*)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.