cleanup requirements and move dependency inside setup.py

Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>

CONTRIBUTING.md

@@ -18,9 +18,22 @@ So assume you have already cloned the repo and are in the working directory with
 a virtual environment already set up, then run:
 
 ```bash
-python setup.py develop && pip install -r requirements-dev.txt
+pip3 install -e . "[.dev]"
 ```
 
+# Dependency Changes
+
+`Sanic` doesn't use `requirements*.txt` files to manage any kind of dependencies related to it in order to simplify the
+effort required in managing the dependencies. Please make sure you have read and understood the following section of
+the document that explains the way `sanic` manages dependencies inside the `setup.py` file.
+
+| Dependency Type                           | Usage                                                                      | Installation                 |
+| ------------------------------------------| -------------------------------------------------------------------------- | ---------------------------  |
+| requirements                              | Bare minimum dependencies required for sanic to function                   | pip3 install -e .            |
+| tests_require / extras_require['test']    | Dependencies required to run the Unit Tests for `sanic`                    | pip3 install -e '[.test]'    |
+| extras_require['dev']                     | Additional Development requirements to add contributing                    | pip3 install -e '[.dev]'     |
+| extras_require['docs']                    | Dependencies required to enable building and enhancing sanic documentation | pip3 install -e '[.docs]'    |
+
 ## Running tests
 
 To run the tests for sanic it is recommended to use tox like so:

docs/sanic/contributing.md

@@ -1,62 +0,0 @@
-# Contributing
-
-Thank you for your interest! Sanic is always looking for contributors. If you
-don't feel comfortable contributing code, adding docstrings to the source files
-is very appreciated.
-
-## Installation
-
-To develop on sanic (and mainly to just run the tests) it is highly recommend to
-install from sources.
-
-So assume you have already cloned the repo and are in the working directory with
-a virtual environment already set up, then run:
-
-```bash
-python setup.py develop && pip install -r requirements-dev.txt
-```
-
-## Running tests
-
-To run the tests for sanic it is recommended to use tox like so:
-
-```bash
-tox
-```
-
-See it's that simple!
-
-## Pull requests!
-
-So the pull request approval rules are pretty simple:
-* All pull requests must pass unit tests
-* All pull requests must be reviewed and approved by at least
-one current collaborator on the project
-* All pull requests must pass flake8 checks
-* If you decide to remove/change anything from any common interface
-a deprecation message should accompany it.
-* If you implement a new feature you should have at least one unit
-test to accompany it.
-
-## Documentation
-
-Sanic's documentation is built
-using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in
-Markdown and can be found in the `docs` folder, while the module reference is
-automatically generated using `sphinx-apidoc`.
-
-To generate the documentation from scratch:
-
-```bash
-sphinx-apidoc -fo docs/_api/ sanic
-sphinx-build -b html docs docs/_build
-```
-
-The HTML documentation will be created in the `docs/_build` folder.
-
-## Warning
-
-One of the main goals of Sanic is speed. Code that lowers the performance of
-Sanic without significant gains in usability, security, or features may not be
-merged. Please don't let this intimidate you! If you have any concerns about an
-idea, open an issue for discussion and help.

docs/sanic/contributing.rst

@@ -0,0 +1,89 @@
+Contributing
+============
+
+Thank you for your interest! Sanic is always looking for contributors.
+If you don’t feel comfortable contributing code, adding docstrings to
+the source files is very appreciated.
+
+Installation
+------------
+
+To develop on sanic (and mainly to just run the tests) it is highly
+recommend to install from sources.
+
+So assume you have already cloned the repo and are in the working
+directory with a virtual environment already set up, then run:
+
+.. code:: bash
+
+   pip3 install -e . '[.dev]'
+
+Dependency Changes
+------------------
+
+``Sanic`` doesn't use ``requirements*.txt`` files to manage any kind of dependencies related to it in order to simplify the
+effort required in managing the dependencies. Please make sure you have read and understood the following section of
+the document that explains the way ``sanic`` manages dependencies inside the ``setup.py`` file.
+
++------------------------+-----------------------------------------------+----------------------------+
+| Dependency Type        | Usage                                         | Installation               |
++========================+===============================================+============================+
+| requirements           | Bare minimum dependencies required for sanic  | pip3 install -e .          |
+|                        | to function                                   |                            |
++------------------------+-----------------------------------------------+----------------------------+
+| tests_require /        | Dependencies required to run the Unit Tests   | pip3 install -e '[.test]'  |
+| extras_require['test'] | for ``sanic``                                 |                            |
++------------------------+-----------------------------------------------+----------------------------+
+| extras_require['dev']  | Additional Development requirements to add    | pip3 install -e '[.dev]'   |
+|                        | contributing                                  |                            |
++------------------------+-----------------------------------------------+----------------------------+
+| extras_require['docs'] | Dependencies required to enable building and  |pip3 install -e '[.docs]'   |
+|                        | enhancing sanic documentation                 |                            |
++------------------------+-----------------------------------------------+----------------------------+
+
+Running tests
+-------------
+
+To run the tests for sanic it is recommended to use tox like so:
+
+.. code:: bash
+
+   tox
+
+See it’s that simple!
+
+Pull requests!
+--------------
+
+So the pull request approval rules are pretty simple:
+
+* All pull requests must pass unit tests
+* All pull requests must be reviewed and approved by at least one current collaborator on the project
+* All pull requests must pass flake8 checks
+* If you decide to remove/change anything from any common interface a deprecation message should accompany it.
+* If you implement a new feature you should have at least one unit test to accompany it.
+
+Documentation
+-------------
+
+Sanic’s documentation is built using `sphinx`_. Guides are written in
+Markdown and can be found in the ``docs`` folder, while the module
+reference is automatically generated using ``sphinx-apidoc``.
+
+To generate the documentation from scratch:
+
+.. code:: bash
+
+   sphinx-apidoc -fo docs/_api/ sanic
+   sphinx-build -b html docs docs/_build
+
+The HTML documentation will be created in the ``docs/_build`` folder.
+
+.. warning::
+    One of the main goals of Sanic is speed. Code that lowers the
+    performance of Sanic without significant gains in usability, security,
+    or features may not be merged. Please don’t let this intimidate you! If
+    you have any concerns about an idea, open an issue for discussion and
+    help.
+
+.. _sphinx: http://www.sphinx-doc.org/en/1.5.1/

requirements-dev.txt

@@ -1,13 +0,0 @@
-aiofiles
-aiohttp>=2.3.0,<=3.2.1
-chardet<=2.3.0
-beautifulsoup4
-coverage
-httptools>=0.0.10
-flake8
-pytest==3.3.2
-tox
-ujson; sys_platform != "win32" and implementation_name == "cpython"
-uvloop; sys_platform != "win32" and implementation_name == "cpython"
-gunicorn
-multidict>=4.0,<5.0

requirements-docs.txt

@@ -1,4 +0,0 @@
-sphinx
-sphinx_rtd_theme
-recommonmark
-sphinxcontrib-asyncio

requirements.txt

@@ -1,6 +0,0 @@
-aiofiles
-httptools>=0.0.10
-ujson; sys_platform != "win32" and implementation_name == "cpython"
-uvloop; sys_platform != "win32" and implementation_name == "cpython"
-websockets>=6.0,<7.0
-multidict>=4.0,<5.0

setup.py

@@ -12,83 +12,90 @@ from setuptools.command.test import test as TestCommand
 
 
 class PyTest(TestCommand):
-    user_options = [('pytest-args=', 'a', "Arguments to pass to pytest")]
+    """
+    Provide a Test runner to be used from setup.py to run unit tests
+    """
+
+    user_options = [("pytest-args=", "a", "Arguments to pass to pytest")]
 
     def initialize_options(self):
         TestCommand.initialize_options(self)
-        self.pytest_args = ''
+        self.pytest_args = ""
 
     def run_tests(self):
         import shlex
         import pytest
+
         errno = pytest.main(shlex.split(self.pytest_args))
         sys.exit(errno)
 
 
-def open_local(paths, mode='r', encoding='utf8'):
+def open_local(paths, mode="r", encoding="utf8"):
-    path = os.path.join(
+    path = os.path.join(os.path.abspath(os.path.dirname(__file__)), *paths)
-        os.path.abspath(os.path.dirname(__file__)),
-        *paths
-    )
 
     return codecs.open(path, mode, encoding)
 
 
-with open_local(['sanic', '__init__.py'], encoding='latin1') as fp:
+with open_local(["sanic", "__init__.py"], encoding="latin1") as fp:
     try:
-        version = re.findall(r"^__version__ = \"([^']+)\"\r?$",
+        version = re.findall(
-                             fp.read(), re.M)[0]
+            r"^__version__ = \"([^']+)\"\r?$", fp.read(), re.M
+        )[0]
     except IndexError:
-        raise RuntimeError('Unable to determine version.')
+        raise RuntimeError("Unable to determine version.")
 
-with open_local(['README.rst']) as rm:
+with open_local(["README.rst"]) as rm:
     long_description = rm.read()
 
 setup_kwargs = {
-    'name': 'sanic',
+    "name": "sanic",
-    'version': version,
+    "version": version,
-    'url': 'http://github.com/channelcat/sanic/',
+    "url": "http://github.com/channelcat/sanic/",
-    'license': 'MIT',
+    "license": "MIT",
-    'author': 'Channel Cat',
+    "author": "Channel Cat",
-    'author_email': 'channelcat@gmail.com',
+    "author_email": "channelcat@gmail.com",
-    'description': (
+    "description": (
-        'A microframework based on uvloop, httptools, and learnings of flask'),
+        "A microframework based on uvloop, httptools, and learnings of flask"
-    'long_description': long_description,
+    ),
-    'packages': ['sanic'],
+    "long_description": long_description,
-    'platforms': 'any',
+    "packages": ["sanic"],
-    'classifiers': [
+    "platforms": "any",
-        'Development Status :: 4 - Beta',
+    "classifiers": [
-        'Environment :: Web Environment',
+        "Development Status :: 4 - Beta",
-        'License :: OSI Approved :: MIT License',
+        "Environment :: Web Environment",
-        'Programming Language :: Python :: 3.5',
+        "License :: OSI Approved :: MIT License",
-        'Programming Language :: Python :: 3.6',
+        "Programming Language :: Python :: 3.5",
-        'Programming Language :: Python :: 3.7',
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
     ],
 }
 
-env_dependency = '; sys_platform != "win32" and implementation_name == "cpython"'
+env_dependency = (
-ujson = 'ujson>=1.35' + env_dependency
+    '; sys_platform != "win32" ' 'and implementation_name == "cpython"'
-uvloop = 'uvloop>=0.5.3' + env_dependency
+)
+ujson = "ujson>=1.35" + env_dependency
+uvloop = "uvloop>=0.5.3" + env_dependency
 
 requirements = [
-    'httptools>=0.0.10',
+    "httptools>=0.0.10",
     uvloop,
     ujson,
-    'aiofiles>=0.3.0',
+    "aiofiles>=0.3.0",
-    'websockets>=6.0,<7.0',
+    "websockets>=6.0,<7.0",
-    'multidict>=4.0,<5.0',
+    "multidict>=4.0,<5.0",
 ]
+
 tests_require = [
-    'pytest==3.3.2',
+    "pytest==3.3.2",
-    'multidict>=4.0,<5.0',
+    "multidict>=4.0,<5.0",
-    'gunicorn',
+    "gunicorn",
-    'pytest-cov',
+    "pytest-cov",
-    'aiohttp>=2.3.0,<=3.2.1',
+    "aiohttp>=2.3.0,<=3.2.1",
-    'beautifulsoup4',
+    "beautifulsoup4",
     uvloop,
     ujson,
-    'pytest-sanic',
+    "pytest-sanic",
-    'pytest-sugar'
+    "pytest-sugar",
 ]
 
 if strtobool(os.environ.get("SANIC_NO_UJSON", "no")):
@@ -102,9 +109,21 @@ if strtobool(os.environ.get("SANIC_NO_UVLOOP", "no")):
     requirements.remove(uvloop)
     tests_require.remove(uvloop)
 
-setup_kwargs['install_requires'] = requirements
+extras_require = {
-setup_kwargs['tests_require'] = tests_require
+    "test": tests_require,
-setup_kwargs['cmdclass'] = {
+    "dev": tests_require + ["aiofiles", "tox", "black", "flake8"],
-    'test': PyTest
+    "docs": [
+        "sphinx",
+        "sphinx_rtd_theme",
+        "recommonmark",
+        "sphinxcontrib-asyncio",
+        "docutils",
+        "pygments"
+    ],
 }
+
+setup_kwargs["install_requires"] = requirements
+setup_kwargs["tests_require"] = tests_require
+setup_kwargs["extras_require"] = extras_require
+setup_kwargs["cmdclass"] = {"test": PyTest}
 setup(**setup_kwargs)