Pypi description

README.rst

@@ -6,52 +6,55 @@ scikit-fda: Functional Data Analysis in Python
 
 |python|_ |build-status| |docs| |Codecov|_ |PyPIBadge|_ |license|_
 
-Functional Data Analysis, or FDA, is the field of Statistics that analyses data that
-depend on a continuous parameter.
+Functional Data Analysis, or FDA, is the field of Statistics that analyses
+data that depend on a continuous parameter.
 
 This package offers classes, methods and functions to give support to FDA
 in Python. Includes a wide range of utils to work with functional data, and its
-representation, exploratory analysis, or preprocessing, among other tasks such as inference, classification,
-regression or clustering of functional data. See documentation for further information on the features 
-included in the package.
+representation, exploratory analysis, or preprocessing, among other tasks
+such as inference, classification, regression or clustering of functional data.
+See documentation for further information on the features included in the
+package.
 
 Documentation
 =============
 
-The documentation is available at 
-`fda.readthedocs.io/en/stable/ <https://fda.readthedocs.io/en/stable/>`_, which 
-includes detailed information of the different modules, classes and methods of the package, along with several examples_ 
-showing different funcionalities. 
+The documentation is available at
+`fda.readthedocs.io/en/stable/ <https://fda.readthedocs.io/en/stable/>`_, which
+includes detailed information of the different modules, classes and methods of
+the package, along with several examples showing different funcionalities.
 
-The documentation of the latest version, corresponding with the develop version of the package, can be found at
+The documentation of the latest version, corresponding with the develop
+version of the package, can be found at
 `fda.readthedocs.io/en/latest/ <https://fda.readthedocs.io/en/latest/>`_.
 
 Installation
 ============
-Currently, *scikit-fda* is available in Python 3.6 and 3.7, regardless of the platform.
+Currently, *scikit-fda* is available in Python 3.6 and 3.7, regardless of the
+platform.
 The stable version can be installed via PyPI_:
 
-.. code:: 
+.. code::
 
     pip install scikit-fda
-    
+
 Installation from source
 ------------------------
-    
-It is possible to install the latest version of the package, available in the develop branch, 
-by cloning this repository and doing a manual installation.
-    
-.. code:: 
+
+It is possible to install the latest version of the package, available in the
+develop branch,  by cloning this repository and doing a manual installation.
+
+.. code::
 
     git clone https://github.com/GAA-UAM/scikit-fda.git
     cd scikit-fda/
     pip install -r requirements.txt    # Install dependencies
     python setup.py install
 
-Make sure that your default Python version is currently supported, or change the python and pip 
-commands by specifying a version, such as ``python3.6``:
+Make sure that your default Python version is currently supported, or change
+the python and pip commands by specifying a version, such as ``python3.6``:
 
-.. code:: 
+.. code::
 
     git clone https://github.com/GAA-UAM/scikit-fda.git
     cd scikit-fda/
@@ -62,8 +65,8 @@ Requirements
 ------------
 *scikit-fda* depends on the following packages:
 
-* `setuptools <https://github.com/pypa/setuptools>`_ - Python Packaging 
-* `cython <https://github.com/cython/cython>`_ - Python to C compiler 
+* `setuptools <https://github.com/pypa/setuptools>`_ - Python Packaging
+* `cython <https://github.com/cython/cython>`_ - Python to C compiler
 * `numpy <https://github.com/numpy/numpy>`_ - The fundamental package for scientific computing with Python
 * `pandas <https://github.com/pandas-dev/pandas>`_ - Powerful Python data analysis toolkit
 * `scipy <https://github.com/scipy/scipy>`_ - Scientific computation in Python
@@ -73,24 +76,29 @@ Requirements
 * `rdata <https://github.com/vnmabus/rdata>`_ - Reader of R datasets in .rda format in Python
 * `scikit-datasets <https://github.com/daviddiazvico/scikit-datasets>`_ - Scikit-learn compatible datasets
 
-The dependencies are automatically installed during the installation. 
+The dependencies are automatically installed.
 
 Contributions
 =============
-All contributions are welcome. You can help this project grow in multiple ways, from creating an issue, reporting an improvement or a bug, to doing a repository fork and creating a pull request to the development branch. 
+All contributions are welcome. You can help this project grow in multiple ways,
+from creating an issue, reporting an improvement or a bug, to doing a
+repository fork and creating a pull request to the development branch.
 
-The people involved at some point in the development of the package can be found in the `contributors file <https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.
+The people involved at some point in the development of the package can be
+found in the `contributors
+file <https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.
 
 Citation
 ========
 If you find this project useful, please cite:
 
-.. todo:: Include citation to scikit-fda paper. 
+.. todo:: Include citation to scikit-fda paper.
 
 License
 =======
 
-The package is licensed under the BSD 3-Clause License. A copy of the license_ can be found along with the code.
+The package is licensed under the BSD 3-Clause License. A copy of the
+license_ can be found along with the code.
 
 .. _examples: https://fda.readthedocs.io/en/latest/auto_examples/index.html
 .. _PyPI: https://pypi.org/project/scikit-fda/
@@ -107,7 +115,7 @@ The package is licensed under the BSD 3-Clause License. A copy of the license_ c
     :alt: Documentation Status
     :scale: 100%
     :target: http://fda.readthedocs.io/en/latest/?badge=latest
-    
+
 .. |Codecov| image:: https://codecov.io/gh/GAA-UAM/scikit-fda/branch/develop/graph/badge.svg
 .. _Codecov: https://codecov.io/github/GAA-UAM/scikit-fda?branch=develop
 

setup.py

@@ -1,3 +1,25 @@
+# encoding: utf-8
+
+"""
+Functional Data Analysis Python package.
+
+Functional Data Analysis, or FDA, is the field of Statistics that analyses
+data that depend on a continuous parameter.
+
+This package offers classes, methods and functions to give support to FDA
+in Python. Includes a wide range of utils to work with functional data, and its
+representation, exploratory analysis, or preprocessing, among other tasks
+such as inference, classification, regression or clustering of functional data.
+See documentation or visit the
+`github page <https://github.com/GAA-UAM/scikit-fda>`_ of the project for
+further information on the features included in the package.
+
+The documentation is available at
+`fda.readthedocs.io/en/stable/ <https://fda.readthedocs.io/en/stable/>`_, which
+includes detailed information of the different modules, classes and methods of
+the package, along with several examples showing different funcionalities.
+"""
+
 import os
 import sys
 
@@ -11,6 +33,8 @@
 needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
 pytest_runner = ['pytest-runner'] if needs_pytest else []
 
+DOCLINES = (__doc__ or '').split("\n")
+
 with open(os.path.join(os.path.dirname(__file__),
                        'VERSION'), 'r') as version_file:
     version = version_file.read().strip()
@@ -32,8 +56,8 @@
 
 setup(name='scikit-fda',
       version=version,
-      description='Functional Data Analysis Python package',
-      long_description="",  # TODO
+      description=DOCLINES[1],
+      long_description="\n".join(DOCLINES[3:]),
       url='https://fda.readthedocs.io',
       maintainer='Carlos Ramos Carreño',
       maintainer_email='[email protected]',
@@ -44,19 +68,25 @@
       packages=find_packages(),
       python_requires='>=3.6, <4',
       classifiers=[
-        'Development Status :: 4 - Beta',
-        'Intended Audience :: Developers',
-        'Intended Audience :: Science/Research',
-        'License :: OSI Approved :: BSD License',
-        'Natural Language :: English',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3.6',
-        'Topic :: Scientific/Engineering :: Mathematics',
-        'Topic :: Software Development :: Libraries :: Python Modules',
+          'Development Status :: 4 - Beta',
+          'Intended Audience :: Developers',
+          'Intended Audience :: Science/Research',
+          'License :: OSI Approved :: BSD License',
+          'Natural Language :: English',
+          'Operating System :: OS Independent',
+          'Programming Language :: Python :: 3.6',
+          'Programming Language :: Python :: 3.7',
+          'Topic :: Scientific/Engineering :: Mathematics',
+          'Topic :: Software Development :: Libraries :: Python Modules',
       ],
-      install_requires=['numpy', 'scikit-learn', 'matplotlib',
-                        'scikit-datasets[cran]>=0.1.24', 'rdata', 'mpldatacursor'],
+      install_requires=['numpy',
+                        'scikit-learn',
+                        'matplotlib',
+                        'scikit-datasets[cran]>=0.1.24',
+                        'rdata',
+                        'mpldatacursor'],
       setup_requires=pytest_runner,
-      tests_require=['pytest', 'numpy>=1.14'],
+      tests_require=['pytest',
+                     'numpy>=1.14'],
       test_suite='tests',
       zip_safe=False)