setup.py

# -*- coding: utf-8 -*-
#Extracting requrements from requirements.txt
# with open('requirements.txt') as f:
#     requirements = f.read().splitlines()

# from Cython.Build import cythonize
from setuptools import setup, find_packages


# Ceci n'est qu'un appel de fonction. Mais il est trèèèèèèèèèèès long
# et il comporte beaucoup de paramètres
def setup_package():
    setup(

    # le nom de votre bibliothèque, tel qu'il apparaitre sur pypi
    name='summit',

    # la version du code
    version=0.0,
    python_requires = '>=3.5',
    # Liste les packages à insérer dans la distribution
    # plutôt que de le faire à la main, on utilise la foncton
    # find_packages() de setuptools qui va cherche tous les packages
    # python recursivement dans le dossier courant.
    # C'est pour cette raison que l'on a tout mis dans un seul dossier:
    # on peut ainsi utiliser cette fonction facilement
    packages=find_packages(),

    # votre pti nom
    author="Baptiste Bauvin",

    # Votre email, sachant qu'il sera publique visible, avec tous les risques
    # que ça implique.
    author_email="baptiste.bauvin@lis-lab.fr",

    # Une description courte
    description="Supervised MultiModal Integration Tool",

    # Une description longue, sera affichée pour présenter la lib
    # Généralement on dump le README ici
    long_description=open('README.rst').read(),

    # Vous pouvez rajouter une liste de dépendances pour votre lib
    # et même préciser une version. A l'installation, Python essayera de
    # les télécharger et les installer.
    #
    # Ex: ["gunicorn", "docutils >= 0.3", "lxml==0.5a7"]
    #
    # Dans notre cas on en a pas besoin, donc je le commente, mais je le
    # laisse pour que vous sachiez que ça existe car c'est très utile.
    # install_requires= ,

    # Active la prise en compte du fichier MANIFEST.in
    include_package_data=True,
    # dependency_links=['https://github.com/aldro61/pyscm.git#egg=pyscm'],
    # Une url qui pointe vers la page officielle de votre lib
    url='http://gitlab.lis-lab.fr/baptiste.bauvin/summit/',
    install_requires=['h5py>=2.9.0', 'joblib>=0.13.2', 'numpy>=1.16.4',
                      'pyparsing>=2.4.0', 'python-dateutil>=2.8.0',
                      'scikit-learn>=0.19.0', 'scipy>=1.3.0', 'six>=1.12.0',
                      'pandas>=0.23.3', 'pyyaml>=3.12', 'plotly>=4.2.1',
                      'matplotlib>=3.1.1', 'tabulate>=0.8.6', 'pyscm-ml>=1.0.0',
                      'randomscm @ git+https://git@github.com/thibgo/randomscm@v0.0.0-alpha'],
    extras_require={
            'dev': ['pytest', 'pytest-cov'],
            'doc': ['sphinx >= 3.0.2', 'numpydoc', 'docutils', 'sphinx-autoapi',
                    'sphinx_rtd_theme']},

    # Il est d'usage de mettre quelques metadata à propos de sa lib
    # Pour que les robots puissent facilement la classer.
    # La liste des marqueurs autorisées est longue:
    # https://pypi.python.org/pypi?%3Aaction=list_classifiers.
    #
    # Il n'y a pas vraiment de règle pour le contenu. Chacun fait un peu
    # comme il le sent. Il y en a qui ne mettent rien.
    classifiers=[
        "Programming Language :: Python",
        "Development Status :: 1 - Planning",
        "License :: OSI Approved",
        "Natural Language :: French",
        "Operating System :: OS Independent",
        "Programming Language :: Python :: 2/3",
        "Topic :: Machine Learning",
    ],

    # C'est un système de plugin, mais on s'en sert presque exclusivement
    # Pour créer des commandes, comme "django-admin".
    # Par exemple, si on veut créer la fabuleuse commande "proclame-sm", on
    # va faire pointer ce nom vers la fonction proclamer(). La commande sera
    # créé automatiquement.
    # La syntaxe est "nom-de-commande-a-creer = package.module:fonction".
    # entry_points={
    #     'console_scripts': [
    #         'exec_multiview = summit.execute:exec',
    #     ],
    # },

    # A fournir uniquement si votre licence n'est pas listée dans "classifiers"
    # ce qui est notre cas
    license="GNUGPL",

    # Il y a encore une chiée de paramètres possibles, mais avec ça vous
    # couvrez 90% des besoins
    # ext_modules=cythonize(
    #     "summit/multiview_platform/monoview/additions/_custom_criterion.pyx"),
)

if __name__ == "__main__":
    setup_package()