refactor: Refactored package for incoming v0.2

.flake8

@@ -1,4 +1,5 @@
 [flake8]
 max-line-length = 120
-ignore = F401, E402, E265, F403, W503, W504, F821
-exclude = venv*, .circleci, .git, docs
+ignore = E402, E265, F403, W503, W504, E731
+exclude = .github, .git, venv*, docs, build
+per-file-ignores = **/__init__.py:F401

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: 🐛 Bug report
+description: Create a report to help us improve the library
+labels: bug
+assignees: frgfm
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      #### Before reporting a bug, please check that the issue hasn't already been addressed in [the existing and past issues](https://github.com/pyronear/pyro-vision/issues?q=is%3Aissue).
+- type: textarea
+  attributes:
+    label: Bug description
+    description: |
+      A clear and concise description of what the bug is.
+
+      Please explain the result you observed and the behavior you were expecting.
+    placeholder: |
+      A clear and concise description of what the bug is.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Code snippet to reproduce the bug
+    description: |
+      Sample code to reproduce the problem.
+
+      Please wrap your code snippet with ```` ```triple quotes blocks``` ```` for readability.
+    placeholder: |
+      ```python
+      Sample code to reproduce the problem
+      ```
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Error traceback
+    description: |
+      The error message you received running the code snippet, with the full traceback.
+
+      Please wrap your error message with ```` ```triple quotes blocks``` ```` for readability.
+    placeholder: |
+      ```
+      The error message you got, with the full traceback.
+      ```
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      Please run the following command and paste the output below.
+      ```sh
+      wget https://raw.githubusercontent.com/pyronear/pyro-vision/master/scripts/collect_env.py
+      # For security purposes, please check the contents of collect_env.py before running it.
+      python collect_env.py
+      ```
+  validations:
+    required: true
+- type: markdown
+  attributes:
+    value: >
+      Thanks for helping us improve the library!

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Usage questions
+    url: https://github.com/pyronear/pyro-vision/discussions
+    about: Ask questions and discuss with other Pyronear community members

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: 🚀 Feature request
+description: Submit a proposal/request for a new feature for pyrovision
+labels: enhancement
+assignees: frgfm
+
+body:
+- type: textarea
+  attributes:
+    label: 🚀 Feature
+    description: >
+      A clear and concise description of the feature proposal
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Motivation & pitch
+    description: >
+      Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Alternatives
+    description: >
+      A description of any alternative solutions or features you've considered, if any.
+- type: textarea
+  attributes:
+    label: Additional context
+    description: >
+      Add any other context or screenshots about the feature request.
+- type: markdown
+  attributes:
+    value: >
+      Thanks for contributing 🎉

.github/validate_deps.py

@@ -0,0 +1,64 @@
+from pathlib import Path
+
+import requirements
+from requirements.requirement import Requirement
+
+# Deps that won't have a specific requirements.txt
+IGNORE = ["flake8", "isort", "mypy", "pydocstyle"]
+# All req files to check
+REQ_FILES = ["requirements.txt", "tests/requirements.txt", "docs/requirements.txt"]
+
+
+def main():
+
+    # Collect the deps from all requirements.txt
+    folder = Path(__file__).parent.parent.absolute()
+    req_deps = {}
+    for file in REQ_FILES:
+        with open(folder.joinpath(file), 'r') as f:
+            _deps = [(req.name, req.specs) for req in requirements.parse(f)]
+
+        for _dep in _deps:
+            lib, specs = _dep
+            assert req_deps.get(lib, specs) == specs, f"conflicting deps for {lib}"
+            req_deps[lib] = specs
+
+    # Collect the one from setup.py
+    setup_deps = {}
+    with open(folder.joinpath("setup.py"), 'r') as f:
+        setup = f.readlines()
+    lines = setup[setup.index("_deps = [\n") + 1:]
+    lines = [_dep.strip() for _dep in lines[:lines.index("]\n")]]
+    lines = [_dep.split('"')[1] for _dep in lines if _dep.startswith('"')]
+    _reqs = [Requirement.parse(_line) for _line in lines]
+    _deps = [(req.name, req.specs) for req in _reqs]
+    for _dep in _deps:
+        lib, specs = _dep
+        assert setup_deps.get(lib) is None, f"conflicting deps for {lib}"
+        setup_deps[lib] = specs
+
+    # Remove ignores
+    for k in IGNORE:
+        if isinstance(req_deps.get(k), list):
+            del req_deps[k]
+        if isinstance(setup_deps.get(k), list):
+            del setup_deps[k]
+
+    # Compare them
+    assert len(req_deps) == len(setup_deps)
+    mismatches = []
+    for k, v in setup_deps.items():
+        assert isinstance(req_deps.get(k), list)
+        if req_deps[k] != v:
+            mismatches.append((k, v, req_deps[k]))
+
+    if len(mismatches) > 0:
+        mismatch_str = "version specifiers mismatches:\n"
+        mismatch_str += '\n'.join(
+            f"- {lib}: {setup} (from setup.py) | {reqs} (from requirements)"
+            for lib, setup, reqs in mismatches
+        )
+        raise AssertionError(mismatch_str)
+
+if __name__ == "__main__":
+    main()

.github/validate_headers.py

@@ -29,7 +29,7 @@
 
 
 IGNORED_FILES = ["version.py", "__init__.py"]
-FOLDERS = ["pyrovision", "scripts", "references"]
+FOLDERS = ["pyrovision", "scripts"]
 
 
 def main():
@@ -54,6 +54,7 @@ def main():
                     for option in HEADERS
                 ):
                     invalid_files.append(source_path)
+
     if len(invalid_files) > 0:
         invalid_str = "\n- " + "\n- ".join(map(str, invalid_files))
         raise AssertionError(f"Invalid header in the following files:{invalid_str}")

.github/workflows/builds.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: [3.7, 3.8, 3.9]
+        python: [3.7, 3.8]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
@@ -28,9 +28,6 @@ jobs:
           key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('**/*.py') }}
           restore-keys: |
             ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
-            ${{ runner.os }}-pkg-deps-${{ matrix.python }}-
-            ${{ runner.os }}-pkg-deps-
-            ${{ runner.os }}-
       - name: Install package
         run: |
           python -m pip install --upgrade pip

.github/workflows/docker.yml

@@ -7,11 +7,11 @@ on:
     branches: master
 
 jobs:
-  docker-ready:
+  docker-package:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Build docker image
-        run: docker build . -t pyrovision-py3.8.1-torch1.7-slim
+        run: docker build . -t pyrovision:latest-py3.8.1-slim
       - name: Run docker container
-        run: docker run pyrovision-py3.8.1-torch1.7-slim python -c "import pyrovision; print(pyrovision.__version__)"
+        run: docker run pyrovision:latest-py3.8.1-slim python -c 'import pyrovision'

.github/workflows/docs.yaml

@@ -27,14 +27,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('docs/requirements.txt') }}-
             ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
-            ${{ runner.os }}-pkg-deps-${{ matrix.python }}-
-            ${{ runner.os }}-pkg-deps-
-            ${{ runner.os }}-
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -e .
-          pip install -r docs/requirements.txt
+          pip install -e ".[docs]"
 
       - name: Build documentation
         run: sphinx-build docs/source docs/build -a -v