Restructure project (#31)

Restructure project

.flake8

@@ -0,0 +1,15 @@
+[flake8]
+# E203: whitespace before ‘:’
+# E266: too many leading ‘#’ for block comment
+# E501: line too long (82 > 79 characters)
+# W503: line break before binary operator
+ignore = E203, E266, E501, W503
+max-line-length = 88
+max-complexity = 18
+# C: All C class violations are reported when the user specifies flake8 --max-complexity
+# E: All E class violations are "errors" reported by pycodestyle
+# F: All F class violations are reported by pyflakes
+# W: All W class violations are "warnings" reported by pycodestyle
+# B: All B class violations are "bugbear" checks
+# B9: All B9 class violations are "bugbear" opinionated checks
+select = B,C,E,F,W,T4,B9

.travis.yml

@@ -15,17 +15,14 @@ addons:
   apt:
     update: true
 install: &requirements
-- pip install -r dev-requirements.txt
+- pip install -r requirements.txt
 - pip install -e .
 jobs:
   include:
   - stage: Tests
     install: *requirements
     script:
-    - pip install codecov
-    - pip --no-cache-dir install --upgrade git+https://github.com/thisch/pytest-sphinx.git pytest
-    - pip --no-cache-dir install pytest-cov
-    - pytest -x -s -vvv --doctest-modules ashpy tests --cov=ashpy
+    - tox -e py37
     after_success:
     - codecov
   - stage: Black

CONTRIBUTING.md

@@ -18,13 +18,13 @@ If you have improvements to AshPy, send us your pull requests! For those
 just getting started, please refer to [this](https://github.com/zurutech/ashpy/blob/master/.github/pull_request_template.md) pull request template.
 
 AshPy team members will be assigned to review your pull requests. Once the
-pull requests are approved and pass all the tests, your pull request will 
+pull requests are approved and pass all the tests, your pull request will
 be merged into the official codebase.
 
 If you want to contribute, start working through the AshPy codebase,
 navigate to the
 [Github "issues" tab](https://github.com/zurutech/ashpy/issues) and start
-looking through interesting issues. 
+looking through interesting issues.
 
 ### Contribution guidelines and standards
 
@@ -44,10 +44,10 @@ AshPy coding style.
     (by default) transferred to the AshPy team. This means that the benefit
     of the contribution must be compared against the cost of maintaining the
     feature.
-    
+
 #### License
 
-We'd love to accept your patches! Before we can take them, you need to understand 
+We'd love to accept your patches! Before we can take them, you need to understand
 that the code you provide will be included with the Apache License.
 
 You can see an example of the licence [here](https://github.com/zurutech/ashpy/blob/master/LICENSE).
@@ -70,34 +70,31 @@ Please, put the following lincense header in your files.
 
 #### Python coding style
 
-Changes to AshPy Python code should conform to
+- Black is our one and only formatter
+- We are more lenient with the length of the line
+- Changes to AshPy Python code should conform to
 [Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md)
 
-Use `pylint` to check your Python changes. To install `pylint`:
-
-```bash
-pip install pylint
-```
-
-To check a file with `pylint`:
+To run all the lint against your current codebase:
 
 ```bash
-pylint --rcfile=/tmp/pylintrc myfile.py
+tox -e black,pylint,flake8
 ```
 
 #### Running tests
 
-In order to run the doctests first you need to install the `pytest-sphinx` package and `pytest-cov` package:
+In order to run the tests and the doctests:
 
 ```bash
-pip --no-cache-dir install --upgrade git+https://github.com/thisch/pytest-sphinx.git pytest
-pip install pytest-cov
+tox -e testenv
 ```
 
-Then you can run tests with coverage statistics with:
+#### Documentation
+
+To generate the documentation either look up the Sphinx docs or simply:
 
 ```bash
-pytest -x -s -vvv --doctest-modules ashpy --cov=ashpy
+tox -e docs
 ```
 
 ## Attribution

README.md

@@ -15,7 +15,7 @@
 [![Black - Badge](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![CodeFactor](https://www.codefactor.io/repository/github/zurutech/ashpy/badge)](https://www.codefactor.io/repository/github/zurutech/ashpy)
 
-AshPy is a TensorFlow 2.0 library for (**distributed**) training, evaluation, model selection, and fast prototyping.
+AshPy is a TensorFlow 2.1 library for (**distributed**) training, evaluation, model selection, and fast prototyping.
 It is designed to ease the burden of setting up all the nuances of the architectures built to train complex custom deep learning models.
 
 [Quick Example](#quick-example) | [Features](#features) | [Set Up](#set-up) | [Usage](#usage) | [Dataset Output Format](#dataset-output-format) | [Test](#test)
@@ -147,10 +147,6 @@ The following README aims to help you understand what you need to do to setup As
 
 ### Pip install
 ```bash
-# Depending on GPU support you might want to install
-# tensorflow-gpu or tensorflow
-pip install tensorflow-gpu==2.0.0beta1
-#pip install tensorflow==2.0.0beta1
 pip install ashpy
 ```
 
@@ -464,15 +460,8 @@ Where `a` is the input sample, `b` is the label/condition (if any, otherwise fil
 To train Pix2Pix-like architecture, that have no `noise` as ConvGenerator input, just return the values in thee format `(tuple(a,b), b)` since the condition is the generator output.
 
 ## Test
-In order to run the doctests first you need to install the `pytest-sphinx` package and `pytest-cov` package:
+In order to run the tests (with the doctests), linting and docs generation simply use `tox`.
 
 ```bash
-pip --no-cache-dir install --upgrade git+https://github.com/thisch/pytest-sphinx.git pytest
-pip install pytest-cov
-```
-
-Then you can run tests with coverage statistics with:
-
-```bash
-pytest -x -s -vvv --doctest-modules ashpy --cov=ashpy
+tox
 ```

pyproject.toml

@@ -0,0 +1,11 @@
+[build-system]
+requires = ["wheel", "setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.isort]
+multi_line_output=3
+include_trailing_comma=true
+force_grid_wrap=0
+use_parentheses=true
+line_length=88
+skip="docs/source/conf.py"

requirements.in/base.txt

@@ -0,0 +1,4 @@
+# Core
+
+tensorflow
+tensorflow_hub

requirements.in/dev.txt

@@ -0,0 +1,14 @@
+# Core
+-r base.txt
+
+# Dev
+rope
+
+# Docs
+-r docs.txt
+
+# Linting
+-r linting.txt
+
+# Testing
+-r test.txt

requirements.in/docs.txt

@@ -0,0 +1,9 @@
+# Documentation
+
+doc8
+# m2r
+pydocstyle
+sphinx
+sphinx-autobuild
+sphinx-autodoc-typehints
+sphinx-rtd-theme

requirements.in/linting.txt

@@ -0,0 +1,8 @@
+# Linting
+
+black
+flake8
+flake8-bugbear
+isort
+mypy
+pylint

requirements.in/test.txt

@@ -0,0 +1,7 @@
+# Testing
+
+codecov
+pytest
+pytest-cov
+tox
+-e git+https://github.com/thisch/pytest-sphinx.git#egg=pytest-sphinx