From 50430a2ed5febd4c2383ee51d1dd47a3d7177832 Mon Sep 17 00:00:00 2001 From: Lilian Besson Date: Wed, 14 Nov 2018 15:12:55 +0100 Subject: [PATCH] =?UTF-8?q?Publi=C3=A9=20sur=20https://pypi.org/project/pa?= =?UTF-8?q?rcoursup/,=20cf=20#14?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 2 +- README.md | 8 +- README.rst | 335 ++++++++++++++++++++++++++++++++++++++++++ docs/README.md | 8 +- donnees/README.md | 4 +- logs/README.md | 4 +- notebooks/README.md | 4 +- parcoursup/README.md | 4 +- requirements.txt | 19 +-- requirements_full.txt | 23 +++ setup.py | 8 +- tests/README.md | 4 +- utils/README.md | 4 +- 13 files changed, 386 insertions(+), 41 deletions(-) create mode 100644 README.rst create mode 100644 requirements_full.txt diff --git a/Makefile b/Makefile index 5966fbf..a05f0da 100644 --- a/Makefile +++ b/Makefile @@ -60,7 +60,7 @@ twine: twine upload --sign --repository pypi dist/*.whl clean_pypi_build: - -mv -vf dist/* /tmp/ + -mv -vf dist/* parcoursup.egg-info /tmp/ sdist: sdist.zip sdist.tar.gz sdist.zip: python3 setup.py sdist --formats=zip diff --git a/README.md b/README.md index acf0e9b..496898f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ > [Écrit par](AUTHORS) deux doctorants de [l'équipe SCEE](http://www-scee.rennes.supelec.fr/wp/phd/) de [CentraleSupélec, campus de Rennes](http://www.rennes.centralesupelec.fr/), [Lilian Besson (@Naereen)](https://github.com/Naereen) et [Bastien Trotobas (@BastienTr)](https://github.com/BastienTr), et d'[autres collaborateur-trice-s](https://github.com/Naereen/ParcourSup.py/graphs/contributors). [![Open Source ? Oui !](https://badgen.net/badge/Open%20Source%20%3F/Oui%20%21/blue?icon=github)](https://github.com/Naereen/ParcourSup.py/) -[![Implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![Version de Python](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![Implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![Version de Python](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintenu%3F-Oui%20%21-green.svg)](https://GitHub.com/Naereen/ParcourSup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Posez-une%20question-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/ParcourSup.py/README.md?pixel)](https://GitHub.com/Naereen/ParcourSup.py/) @@ -160,8 +160,8 @@ Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE] © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. [![Open Source ? Oui !](https://badgen.net/badge/Open%20Source%20%3F/Oui%20%21/blue?icon=github)](https://github.com/Naereen/ParcourSup.py/) -[![Implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![Version de Python](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![Implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![Version de Python](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintenu%3F-Oui%20%21-green.svg)](https://GitHub.com/Naereen/ParcourSup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Posez-une%20question-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/ParcourSup.py/README.md?pixel)](https://GitHub.com/Naereen/ParcourSup.py/) diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d0c7441 --- /dev/null +++ b/README.rst @@ -0,0 +1,335 @@ +Un clone en Python 3 de `Parcoursup `_, écrit à but didactique +========================================================================================== + + `Écrit par `_ deux doctorants de `l'équipe + SCEE `_ de + `CentraleSupélec, campus de + Rennes `_, `Lilian Besson (Naereen) `_ et `Bastien Trotobas (BastienTr) `_, et d'`autres + collaborateur-trice-s `_. + +|Open Source ? Oui !| |Implementation| |Version de Python| |Maintenance| +|Ask Me Anything !| |Analytics| |Documentation Status| |Build Status| +|Stars of https://github.com/Naereen/ParcourSup.py/| |Releases of +https://github.com/Naereen/ParcourSup.py/| + +Présentation +------------ + +Ce dépôt contient un clone (presque complet) des algorithmes régissant +la `plateforme Parcoursup `_, qui gère +depuis 2018 les affectations des élèves de classe de Terminale (dans +les lycées en France) dans leurs formations dans l'enseignement +supérieur. + +Les algorithmes et l'implémentation officielle (en Java) ont été +distribués en accès libre, et sous licence libre (GPL), en mai 2018. En +2018, ils étaient hébergés sur `ce site +(framagit.org/parcoursup/algorithmes-de-parcoursup) `_. + +- Nous proposons ici une implémentation complète des différents + algorithmes de Parcoursup, écrite en Python 3, dans un style très + clair, avec des commentaires, et `une + documentation `_. + |Documentation Status| +- Nous avons pour objectif de comprendre et d'expliquer ces + algorithmes, en utilisant au maximum des notions et des modules + Python qui soient abordables et compréhensibles par des élèves de + classes préparatoires scientifiques (typiquement des MPSI). +- *Note* : Vous pouvez contribuer si vous le souhaiter ! `Une erreur à + signaler ? `_, + ou `une contribution + possible `_ ? + Merci d'avance ! + +-------------- + +Plan de bataille +---------------- + + Pour le développement en cours, cf. ce fichier + `TODO.md `_ ! + +.. + + |Commits of https://github.com/Naereen/ParcourSup.py/| / |Date of + last commit of https://github.com/Naereen/ParcourSup.py/| |Issues of + https://github.com/Naereen/ParcourSup.py/| : |Open issues of + https://github.com/Naereen/ParcourSup.py/| / |Closed issues of + https://github.com/Naereen/ParcourSup.py/| + +Explications +------------ + +- Pour l'instant, nous avons implémenté dans le dossier + `parcoursup/ `_ un clone complet du code Java + initial, écrit en Python 3. +- Et dans le dossier `notebooks/ `_ nous proposons des + implémentations simplifiées des principaux algorithmes, écrites sans + dépendances et dans un style très didactique, avec des visualisations + interactives afin de permettre à tout le monde d'expérimenter un peu + et de visualiser le comportement des algorithmes. L'accent est mis + sur la compréhension rapide de l'influence des différents paramètres + numériques. + +- TODO expliquer l'algorithme dans les grandes lignes, avec notre + propre vocabulaire, ici. + +Organisation de ce dépôt +------------------------ + +- Des visualisations sont `aussi dans le dossier + notebooks/ `_. TODO encore à travailler ! +- Le code des algorithmes est `dans le dossier + parcoursup/ `_, comme le code Java initial, c'est + découpé en deux modules, `ordreappel `_ + et `propositions `_, +- Les (exemples de) données synthétiques générées sont `dans le dossier + donnees/ `_, +- Des tests (plusieurs centaines) sont présents dans le dossier + `tests/ `_, inspirés par `ce + projet `_, + |Build Status| +- Une documentation de notre implémentation complète est disponible en + ligne, `sur la page + suivante `_, + construite avec Sphinx à partir des fichiers présents dans `le + dossier docs/ `_, +- Des utilitaires sont `dans le dossier utils/ `_, + +Démonstration dans un `notebook Jupyter `_ +--------------------------------------------------------------------- + +- Des visualisations sont dans `le dossier + notebooks/ `_. + +|Binder| + +|Google Colab| + +-------------- + +Documentation officielle et ressources +-------------------------------------- + +- La page officielle de présentation de Parcoursup est + `ici `_ + (en 2018). + +Communications journalistiques, entre le 23 mai 2018 et le 15 juillet +2018 : + +- Les indicateurs quotidiennement publiés par le ministère sont sur + `cette page + là `_ + (en juin 2018). + +- Cette carte qui montre jour après jour les résultats donnés par + Parcoursup : + `statistiques.parcoursup.fr `_. + > Nous voulons proposer notre propre carte de visualisation, `c'est + en cours `_… + +Des détails sur les algorithmes : + +- `Ce document + texte `_ + et `cet autre document + PDF `_ + donnent plein d'explications. + +- `Ce texte du Journal + Officiel `_ + montre l'autorisation donnée par la CNIL pour la création de la base + de données pour Parcoursup, et détaille un peu toutes les + informations stockées pour le service. Il est important de garder en + tête que ces données ne sont **pas** utilisées par les algorithmes de + Parcoursup, qui n'utilisent qu'un identifiant unique et anonyme pour + identifier chaque candidat-e. + +Autres ressources, moins techniques mais plus pédagogiques : + +- `Le dossier de presse du + ministère `_ + pour Parcoursup + +- Ces articles sur des blogs du Monde: sur + `ingenuingenieur.blog.lemonde.fr `_, + sur + `enseigner.blog.lemonde.fr `_ + ou sur + `binaire.blog.lemonde.fr `_. + +- `Cet autre article par Clémence Réda est + instructif `_. + +-------------- + +Exemples +-------- + +Installation +~~~~~~~~~~~~ + +Ces lignes de `Bash `_ (à exécuter +sur une machine type GNU/Linux ou un Mac avec les outils standards) +clone ce dépôt, et installent un `virtualenv +Python `_ et installent `les +dépendances `_ dans cet environnement virtuel : + +.. code:: bash + + cd /tmp/ + git clone https://GitHub.com/Naereen/ParcourSup.py + cd Parcoursup.py/ + make install + +.. + + Note : Il n'est pas nécessaire d'utiliser un virtualenv, mais + c'est recommandé. Vous pouvez simplement installer les modules + requis avec sudo pip install -r requirements.txt. + +.. + + Note : notre code n'est pas spécifiquement écrit pour une machine + utilisant GNU/Linux, et il devrait fonctionner sur n'importe quelle + plateforme qui supporte Python 3.6 (Microsoft Windows et Mac OS X + notamment). Il est testé sous GNU/Linux (XUbuntu) *et* sous + Microsoft Windows 7. `N'hésitez pas à signaler un + problème `_, + si besoin. Merci d'avance ! + +Tests |Build Status| +~~~~~~~~~~~~~~~~~~~~ + +Les tests qui reproduisent +(`presque `_) +parfaitement `les données d'exemples `_ peuvent être exécutés +avec les deux commandes suivantes : + +- Ordres d'appel : + +.. code:: bash + + $ . env/bin/activate ; python3 ./parcoursup/ordreappel/__init__.py + ... + +- Proposition de vœux : + +.. code:: bash + + $ . env/bin/activate ; python3 ./parcoursup/propositions/__init__.py + ... + +- Ces deux tests prennent environ 30 secondes chacun. + + Note : Il n'est pas nécessaire d'utiliser un virtualenv, mais + c'est recommandé. Vous pouvez simplement faire les tests avec + python3 ./parcoursup/ordreappel/__init__.py et + python3 ./parcoursup/propositions/__init__.py. + +- Des tests supplémentaires ont été récemment ajoutés (voir + `#3 `_). + +-------------- + +Construire la documentation ? |Documentation Status| +---------------------------------------------------- + +- Demande d'avoir le module `sphinx `_ + installé. (sudo pip3 install sphinx si besoin). +- Puis, dans le dossier principal, il suffit de faire : + +.. code:: bash + + $ make docs + +- Sous Windows ou si GNU Make n'est pas disponible, vous pouvez + construire la documentation manuellement avec les deux commandes + suivantes : + +.. code:: bash + + $ sphinx-apidoc -f -o ./docs -e -M ./parcoursup/ + $ sphinx-build -M html ./docs ./_build + $ ./docs/.fixes_html_in_doc.sh + +-------------- + +À propos +-------- + +Language et versions ? +~~~~~~~~~~~~~~~~~~~~~~ + +`Python v3.6+ `_. Avec les `modules +suivants `_ : + +- `Numpy `_ pour les tableaux, +- `La bibliothèque standard `_ pour tout + le reste. +- `ipython `_, + `Jupyter `_ pour les notebooks. +- `tqdm `_ sont optionnels. + +Licence ? |GitHub license| +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Code libre, `sous licence MIT `_ +(file `LICENSE `_). © `Lilian +Besson `_ et `Bastien +Trotobas `_ et collaborateur-trice-s, +2018. + +|Open Source ? Oui !| |Implementation| |Version de Python| |Maintenance| +|Ask Me Anything !| |Analytics| |Documentation Status| |Build Status| +|Stars of https://github.com/Naereen/ParcourSup.py/| |Releases of +https://github.com/Naereen/ParcourSup.py/| + +|ForTheBadge uses-badges| |ForTheBadge uses-git| |forthebadge +made-with-python| |ForTheBadge built-with-science| + +.. |Open Source ? Oui !| image:: https://badgen.net/badge/Open%20Source%20%3F/Oui%20%21/blue?icon=github + :target: https://github.com/Naereen/ParcourSup.py/ +.. |Implementation| image:: https://img.shields.io/pypi/implementation/parcoursup.svg + :target: https://www.python.org/ +.. |Version de Python| image:: https://img.shields.io/pypi/pyversions/parcoursup.svg + :target: https://docs.python.org/3/ +.. |Maintenance| image:: https://img.shields.io/badge/Maintenu%3F-Oui%20%21-green.svg + :target: https://GitHub.com/Naereen/ParcourSup.py/graphs/commit-activity +.. |Ask Me Anything !| image:: https://img.shields.io/badge/Posez-une%20question-1abc9c.svg + :target: https://GitHub.com/Naereen/ama +.. |Analytics| image:: https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/ParcourSup.py/README.md?pixel + :target: https://GitHub.com/Naereen/ParcourSup.py/ +.. |Documentation Status| image:: https://readthedocs.org/projects/parcoursuppy/badge/?version=latest + :target: https://parcoursuppy.readthedocs.io/fr/latest/?badge=latest +.. |Build Status| image:: https://travis-ci.org/Naereen/ParcourSup.py.svg?branch=master + :target: https://travis-ci.org/Naereen/ParcourSup.py +.. |Stars of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/stars/Naereen/ParcourSup.py + :target: https://GitHub.com/Naereen/ParcourSup.py/stargazers +.. |Releases of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/release/Naereen/ParcourSup.py + :target: https://github.com/Naereen/ParcourSup.py/releases +.. |Commits of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/commits/Naereen/ParcourSup.py + :target: https://github.com/Naereen/ParcourSup.py/commits/master +.. |Date of last commit of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/last-commit/Naereen/ParcourSup.py + :target: https://github.com/Naereen/ParcourSup.py/commits/master +.. |Issues of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/issues/Naereen/ParcourSup.py + :target: https://GitHub.com/Naereen/ParcourSup.py/issues +.. |Open issues of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/open-issues/Naereen/ParcourSup.py + :target: https://github.com/Naereen/ParcourSup.py/issues?q=is%3Aopen+is%3Aissue +.. |Closed issues of https://github.com/Naereen/ParcourSup.py/| image:: https://badgen.net/github/closed-issues/Naereen/ParcourSup.py + :target: https://github.com/Naereen/ParcourSup.py/issues?q=is%3Aclosed+is%3Aissue +.. |Binder| image:: https://mybinder.org/badge.svg + :target: https://mybinder.org/v2/gh/Naereen/ParcourSup.py/master?filepath=notebooks%2FParcourSup.py_version_simplifiee.ipynb +.. |Google Colab| image:: https://badgen.net/badge/Lancer/sur%20Google%20Colab/blue?icon=terminal + :target: https://colab.research.google.com/github/Naereen/ParcourSup.py/blob/master/notebooks/ParcourSup.py_version_simplifiee.ipynb +.. |GitHub license| image:: https://img.shields.io/github/license/Naereen/ParcourSup.py.svg + :target: https://github.com/Naereen/ParcourSup.py/blob/master/LICENSE +.. |ForTheBadge uses-badges| image:: http://ForTheBadge.com/images/badges/uses-badges.svg + :target: http://ForTheBadge.com +.. |ForTheBadge uses-git| image:: http://ForTheBadge.com/images/badges/uses-git.svg + :target: https://GitHub.com/ +.. |forthebadge made-with-python| image:: http://ForTheBadge.com/images/badges/made-with-python.svg + :target: https://www.python.org/ +.. |ForTheBadge built-with-science| image:: http://ForTheBadge.com/images/badges/built-with-science.svg + :target: https://GitHub.com/Naereen/ diff --git a/docs/README.md b/docs/README.md index acf0e9b..496898f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,8 +4,8 @@ > [Écrit par](AUTHORS) deux doctorants de [l'équipe SCEE](http://www-scee.rennes.supelec.fr/wp/phd/) de [CentraleSupélec, campus de Rennes](http://www.rennes.centralesupelec.fr/), [Lilian Besson (@Naereen)](https://github.com/Naereen) et [Bastien Trotobas (@BastienTr)](https://github.com/BastienTr), et d'[autres collaborateur-trice-s](https://github.com/Naereen/ParcourSup.py/graphs/contributors). [![Open Source ? Oui !](https://badgen.net/badge/Open%20Source%20%3F/Oui%20%21/blue?icon=github)](https://github.com/Naereen/ParcourSup.py/) -[![Implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![Version de Python](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![Implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![Version de Python](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintenu%3F-Oui%20%21-green.svg)](https://GitHub.com/Naereen/ParcourSup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Posez-une%20question-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/ParcourSup.py/README.md?pixel)](https://GitHub.com/Naereen/ParcourSup.py/) @@ -160,8 +160,8 @@ Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE] © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. [![Open Source ? Oui !](https://badgen.net/badge/Open%20Source%20%3F/Oui%20%21/blue?icon=github)](https://github.com/Naereen/ParcourSup.py/) -[![Implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![Version de Python](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![Implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![Version de Python](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintenu%3F-Oui%20%21-green.svg)](https://GitHub.com/Naereen/ParcourSup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Posez-une%20question-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/ParcourSup.py/README.md?pixel)](https://GitHub.com/Naereen/ParcourSup.py/) diff --git a/donnees/README.md b/donnees/README.md index 060bc36..fbb3378 100644 --- a/donnees/README.md +++ b/donnees/README.md @@ -50,8 +50,8 @@ Les 7 fichiers de tests pour [l'algorithme de propositions des affectations](src Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/) diff --git a/logs/README.md b/logs/README.md index f047a5b..22b2b5d 100644 --- a/logs/README.md +++ b/logs/README.md @@ -28,8 +28,8 @@ Voir les fichiers suivants pour des exemples de sorties de la commande précéde Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/) diff --git a/notebooks/README.md b/notebooks/README.md index fcdddae..55b5f9c 100644 --- a/notebooks/README.md +++ b/notebooks/README.md @@ -53,8 +53,8 @@ Ce dossier contient des ressources supplémentaires pour expliquer les algorithm Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/) diff --git a/parcoursup/README.md b/parcoursup/README.md index 1c57700..0140130 100644 --- a/parcoursup/README.md +++ b/parcoursup/README.md @@ -14,8 +14,8 @@ Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/) diff --git a/requirements.txt b/requirements.txt index 509f7eb..29b176c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,21 +3,4 @@ # --- For the codebase tqdm>=4.0 -numpy>=1.14 -# matplotlib>=2.0 -# pandas>=0.23 - -# --- For the notebooks -jupyter -ipython -watermark -ipythonblocks - -# --- For the documentation -sphinx # sphinx -sphinx_rtd_theme # better sphinx theme -recommonmark # parser to read Markdown files -# nbsphinx # to include the notebooks as Sphinx pages - -# --- For the tests -behave +numpy>=1.14 \ No newline at end of file diff --git a/requirements_full.txt b/requirements_full.txt new file mode 100644 index 0000000..509f7eb --- /dev/null +++ b/requirements_full.txt @@ -0,0 +1,23 @@ +# --- Hack to try to have f-strings on Python 2 and 3 +# future-fstrings + +# --- For the codebase +tqdm>=4.0 +numpy>=1.14 +# matplotlib>=2.0 +# pandas>=0.23 + +# --- For the notebooks +jupyter +ipython +watermark +ipythonblocks + +# --- For the documentation +sphinx # sphinx +sphinx_rtd_theme # better sphinx theme +recommonmark # parser to read Markdown files +# nbsphinx # to include the notebooks as Sphinx pages + +# --- For the tests +behave diff --git a/setup.py b/setup.py index c38a310..cd49c94 100644 --- a/setup.py +++ b/setup.py @@ -18,9 +18,13 @@ # Get the long description from the README file long_description = "ParcourSup.py : un clone en Python 3 de ParcoursSup, écrit à but didactique" -README = path.join(here, "..", "README.md") +README = path.join(here, "README.rst") +if not path.exists(README): + README = path.join(here, "..", "README.rst") if not path.exists(README): README = path.join(here, "README.md") +if not path.exists(README): + README = path.join(here, "..", "README.md") if path.exists(README): with open(README, encoding="utf-8") as f: long_description = f.read() @@ -35,7 +39,7 @@ print("Are you sure you are building in the correct folder?") # FIXME revert when done uploading the first version to PyPI -version = "0.1.dev9" +# version = "0.1.dev4" setup(name="parcoursup", diff --git a/tests/README.md b/tests/README.md index cd0091a..4e883ce 100644 --- a/tests/README.md +++ b/tests/README.md @@ -62,8 +62,8 @@ Voir les fichiers suivants pour des exemples de sorties de la commande précéde Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/) diff --git a/utils/README.md b/utils/README.md index b3cc1b3..6d04572 100644 --- a/utils/README.md +++ b/utils/README.md @@ -16,8 +16,8 @@ Ce dossier contiendra des scripts utilitaires pour bidouiller des choses, si bes Code libre, [sous licence MIT](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)). © [Lilian Besson](https://GitHub.com/Naereen) et [Bastien Trotobas](https://github.com/BastienTr) et collaborateur-trice-s, 2018. -[![PyPI implementation](https://img.shields.io/pypi/implementation/smpybandits.svg)](https://www.python.org/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/smpybandits.svg)](https://docs.python.org/3/) +[![PyPI implementation](https://img.shields.io/pypi/implementation/parcoursup.svg)](https://www.python.org/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parcoursup.svg)](https://docs.python.org/3/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/Parcoursup.py/graphs/commit-activity) [![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama) [![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/Parcoursup.py/README.md?pixel)](https://GitHub.com/Naereen/Parcoursup.py/)