Merge pull request #414 from Epistimio/release-0.1.8rc2

Release 0.1.8rc2

.flake8

@@ -0,0 +1,71 @@
+[flake8]
+count = True
+show-source = True
+doctests = True
+
+ignore =
+    # Missing docstring in __init__
+    D107
+
+    # blank-line after doc summaries (annoying for modules' doc)
+    D205
+
+    # conflicts with D211: No blank lines allowed before class docstring
+    D203
+
+    # do not enforce first-line-period at module docs
+    D400
+
+    # conflicts with E133: closing bracket is missing indentation
+    E123
+
+    # Line break after binary operator
+    W504
+
+    # Invalid escape sequence
+    W605
+
+    # Local variable never used
+    F841
+
+    # Use of == / != to compare constant literals
+    F632
+
+    # First line should be imperative mood
+    D401
+
+    # Do not perform function calls in argument defaults.
+    B008
+
+    # Do not call getattr with a constant attribute value, it is not any safer than normal property access
+    B009
+
+    # Do not call assert False since python -O removes these calls. Instead callers should raise AssertionError().
+    B011
+
+exclude =
+    .tox,
+    .git,
+    __pycache__,
+    docs,
+    config,
+    build,
+    dist,
+    *.pyc,
+    *.egg-info,
+    .cache,
+    .eggs,
+    src/orion/core/_version.py,
+    src/orion/core/utils/_appdirs.py
+
+# Line length
+max-line-length = 100
+
+# McCabe complexity checker
+max-complexity = 20
+
+# flake8-import-order: style
+import-order-style = google
+
+# flake8-import-order: local module name checker
+application-import-names = orion, versioneer

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Found a bug? Tell us about it!
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Steps to reproduce**
+Describe the steps to reproduce the bug, if applicable:
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 18.04]
+ - Python version: [e.g. 3.7]
+ - Oríon version: [e.g. 0.1.7]
+ - Database: [e.g. PickleDB, MongoDB]
+
+**Additional context**
+If applicable, attach any log of screenshots that can help explain the problem.
+
+** Possible solution**
+If you think you know what the problem is, let us know! Your opinion helps us.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+ - A clear and concise description of what you want to happen.
+ - Motivate how this feature fits [Oríon's mission](https://github.com/Epistimio/orion).
+ - Keep the scope as narrow as possible, to make it easier to implement.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other details, context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+_Hi there! Thank you for contributing. Feel free to use this pull request template; It helps us reviewing your work at its true value._
+
+_Please remove the instructions in italics before posting the pull request :)._
+
+# Description
+_Describe what is the purpose of this pull request and why it should be integrated to the repository. 
+When your changes modify the current behavior, explain why your solution is better._
+
+_If it solves a GitHub issue, be sure to [link it](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls#issues-and-pull-requests)._
+
+# Changes
+_Give an overview of the suggested solution._
+
+# Checklist
+_This is simply a reminder of what we are going to look for before merging your code._
+
+_Add an `x` in the boxes that apply._
+_If you're unsure about any of them, don't hesitate to ask. We're here to help!_ 
+_You can also fill these out after creating the PR if it's a work in progress (be sure to publish the PR as a draft then)_
+
+## Tests
+- [ ] I added corresponding tests for bug fixes and new features. If possible, the tests fail without the changes
+- [ ] All new and existing tests are passing (`$ tox -e py38`; replace `38` by your Python version if necessary)
+
+## Documentation
+- [ ] I have updated the relevant documentation related to my changes
+
+## Quality
+- [ ] I have read the [CONTRIBUTING](https://github.com/Epistimio/orion/blob/develop/CONTRIBUTING.md) doc
+- [ ] My commits messages follow [this format](https://chris.beams.io/posts/git-commit/)
+- [ ] My code follows the style guidelines (`$ tox -e lint`)
+
+# Further comments
+_Please include any additional information or comment that you feel will be helpful to the review of this pull request._

.gitignore

@@ -2,13 +2,17 @@
 *~
 *.sw*
 .idea/
+.vscode/
 .spyderproject
 .spyproject
 .ropeproject
 *.log
 *.pkl
 *.lock
 
+# OS generated files
+.DS_Store
+
 # StarUML documentation
 *.mdj
 

.pylintrc

@@ -51,7 +51,8 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=abstract-class-instantiated,useless-super-delegation,no-member,keyword-arg-before-vararg,unidiomatic-typecheck,redefined-outer-name,fixme,F0401,intern-builtin,wrong-import-position,wrong-import-order
+disable=abstract-class-instantiated,useless-super-delegation,no-member,keyword-arg-before-vararg,unidiomatic-typecheck,redefined-outer-name,fixme,F0401,intern-builtin,wrong-import-position,wrong-import-order,
+        C0415, F0010, R0205, R1705, R1711, R1720, W0106, W0107, W0127, W0706
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -390,7 +391,7 @@ max-locals=20
 max-parents=7
 
 # Maximum number of public methods for a class (see R0904).
-max-public-methods=10
+max-public-methods=12
 
 # Maximum number of return / yield for function / method body
 max-returns=6

.travis.yml

@@ -21,9 +21,6 @@ jobs:
         after_success:
           - tox -e final-coverage
           - tox -e codecov
-        env: TOXENV=py35
-        python: 3.5
-      - <<: *test
         env: TOXENV=py36
         python: 3.6
       - <<: *test
@@ -34,7 +31,12 @@ jobs:
       - <<: *test
         env: TOXENV=py37
         python: 3.7
-        dist: xenial
+        dist: bionic
+        sudo: true
+      - <<: *test
+        env: TOXENV=py38
+        python: 3.8
+        dist: bionic
         sudo: true
       - <<: *test
         env: TOXENV=demo-random

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to Oríon
+Hi there 👋. Thank you for considering contributing to Oríon 🎉. We're excited to have you here!
+
+We present the guidelines for contributing to the project. They are not hard rules, use your best judgment, and feel free to propose changes to this document in a pull request. If you havn't already, it's a good idea to quickly pass through our [code of conduct](https://github.com/Epistimio/orion/blob/develop/CODE_OF_CONDUCT.md) to ensure everyone has a good time.
+
+## Where do I go from here?
+If you have a question, found a bug or have a feature request, you're welcome to open a new issue at https://github.com/Epistimio/orion/issues. It's generally best if you get confirmation of your bug or approval for your feature request before starting to code.
+
+Depending on what you want to do, we're suggesting you read the respective guidelines:
+- [Asking a question](###how-to-ask-a-question)
+- [Reporting a bug](###how-to-report-a-bug)
+- [Proposing enhancements](###how-to-propose-enhancements)
+- [Submitting changes](###how-to-submit-changes)
+
+In some cases, you might want to add a new algorithm for Oríon, make sure to check out the [plugin documentation](https://orion.readthedocs.io/en/latest/plugins/base.html).
+
+### How to ask a question
+Asking a question is also a contribution to the project! We'll be happy to help you if you have any question. Before opening a new issue, make sure to do a quick search. It's possible your question has already been answered! Otherwise, go ahead. We're looking forward to help you.
+
+### How to report a bug
+You found a bug? Great! Before submitting, make sure you're experiencing the bug on the latest version of Oríon and that it's not already opened in our issue tracker.
+
+Please use the [bug report template](https://github.com/Epistimio/orion/issues/new/choose) to open a new bug; make sure to choose a clear and descriptive title for your issue.
+
+### How to propose enhancements
+We're thrilled to hear you found a way to make Oríon better through minor improvements to completely new features!
+Before creating enhancement suggestions, please check that your idea is not already present in the list of issues. You might find that you don't need to create one and can just join in the discussion directly and give your opinion!
+
+Please use the [feature request template](https://github.com/Epistimio/orion/issues/new/choose) to propose changes; make sure to choose a clear and descriptive title for your issue.
+
+### How to submit changes
+We're grateful you're considering making changes to Oríon!
+
+To get started, you need to first fork the repository and then create a new branch on your fork where you'll do your changes.
+
+Once you implemented the changes, make sure to [rebase](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase) your branch on the latest Oríon's *develop* branch and finally submit a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
+All changes to Oríon are done through PRs, where they will be peer-reviewed and checked against our continuous integration system to ensure the quality of the code base.
+
+During this process keep in mind to:
+- Set a descriptive and short branch name
+- Create a descriptive and clear title for the PR
+- Motivate the *why* and *how* of the PR (get inspiration from current or past PRs!)
+- Write [good commits](https://chris.beams.io/posts/git-commit/)
+- Include tests for new features or bug fixes
+- Update the source code documentation (docstring) and, if applicable, the [general documentation](https://orion.readthedocs.io/en/latest/index.html)
+
+Next, you need to get familiar with the developer documentation. You will find the instructions to set up your development environment, including how to use the test suite and verify you changes will pass the CI as well as our style guides for source code and documentation.
+
+-> https://orion.readthedocs.io/en/latest/developer/overview.html
+
+#### Your first contribution
+If you are not sure about what to work on first, we suggest you take a look on the [help wanted](https://github.com/Epistimio/orion/labels/help%20wanted) and [good first issues](https://github.com/Epistimio/orion/labels/good%20first%20issue) opened. They are great places to start!
+
+---
+Thank you for contributing! We really appreciate it!

LICENSE

@@ -1,6 +1,6 @@
 Software License Agreement (BSD License)
 
- Copyright (c) 2017-2018, Epistímio.
+ Copyright (c) 2017-2020, Epistímio.
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without

MANIFEST.in

@@ -2,6 +2,7 @@
 include LICENSE
 include *.rst
 include ROADMAP.md
+include CONTRIBUTING.md
 exclude RESEARCH.md
 
 # Control and setup helpers
@@ -13,15 +14,19 @@ exclude .travis.yml
 exclude tox.ini
 exclude *-requirements.txt
 exclude .pylintrc
+exclude .flake8
 exclude codecov.yml
 exclude .mailmap
 prune conda/
 
 # Include src, tests, docs
-recursive-include docs *.rst *.py *.gitkeep
+recursive-include docs *.rst *.py *.gitkeep *.png
 include docs/requirements.txt
 prune docs/build
 prune docs/src/reference
 recursive-include src *.py
 recursive-include tests *.py *.yaml *.json *.txt *.yml *.in LICENSE
 include tests/requirements.txt
+
+# Include examples
+recursive-include examples *.md *.py */requirements.txt