Update packaging setup following PEP-517 and PEP-518 (#125)

* Update packaging setup following PEP-517 and PEP-518

* Update docs and CI

* Remove unnecessary requirements files

* Update contributing guide

Author: igonro

.github/CONTRIBUTING.md

@@ -26,15 +26,21 @@ We use the following tools for linting and formatting:
 - [black](https://github.com/psf/black): formatter
 - [isort](https://github.com/timothycrosley/isort): sort imports
 
-Style configurations of black and isort can be found in [pyproject.toml](../.pyproject.toml) and [.isort.cfg](../.isort.cfg).
+Style configurations of black and isort can be found in [pyproject.toml](../.pyproject.toml).
 
 We use [pre-commit hook](https://pre-commit.com/) that checks and formats for `flake8`, `yapf`, `isort`,
  fixes `end-of-files`, automatically on every commit.
 The config for a pre-commit hook is stored in [.pre-commit-config](../.pre-commit-config.yaml).
 
-After you clone the repository and installed cond environment, you will need to install initialize pre-commit hook.
+After you clone the repository, install pyodi and development requirements with:
 
+```bash
+pip install -e .[dev]
 ```
+
+Then, you will need to install initialize pre-commit hook:
+
+```bash
 pre-commit install
 ```
 

.github/workflows/ci.yml

@@ -30,12 +30,9 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.7
-      - name: Install build requirements
-        shell: bash -l {0}
-        run: pip install -r requirements/build.txt
       - name: Install pyodi
         shell: bash -l {0}
-        run: rm -rf .eggs && pip install -e .[all]
+        run: rm -rf .eggs && pip install .[dev]
       - name: Test with pytest
         shell: bash -l {0}
         run: pytest

README.md

@@ -36,10 +36,17 @@ A simple tool for explore your object detection dataset. The goal of this librar
 
 
 ## Installation
+
+### From pypi
+```bash
+pip install pyodi
+```
+
+### From source
 ```bash
 git clone https://github.com/Gradiant/pyodi.git
-cd pyodi
-python setup.py install
+cd pyodi/
+pip install .  # or "python setup.py install"
 ```
 
 ## Contributing

pyproject.toml

@@ -1,3 +1,7 @@
+[build-system]
+requires = ["setuptools >= 40.9.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
 [tool.black]
 line-length = 88
 include = '\.pyi?$'
@@ -15,6 +19,7 @@ exclude = '''
   | dist
 )/
 '''
+
 [tool.isort]
 profile = "black"
 known_third_party = ["PIL", "ensemble_boxes", "loguru", "matplotlib", "numba", "numpy", "pandas", "plotly", "pycocotools", "pytest", "setuptools", "sklearn", "typer"]

requirements.txt

@@ -0,0 +1,50 @@
+[metadata]
+name = pyodi
+version = 0.0
+author = Pyodi
+description = Object Detection Insights
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/Gradiant/pyodi
+
+[options]
+packages = find_namespace:
+python_requires = >=3.7
+install_requires =
+  numpy==1.20.1
+  ensemble-boxes==1.0.4
+  loguru==0.5.3
+  matplotlib==3.3.4
+  numba==0.52.0
+  pandas==1.2.1
+  pillow==8.1.0
+  plotly==4.14.3
+  pycocotools-fix @ git+https://github.com/junjuew/cocoapi.git#subdirectory=PythonAPI
+  kaleido==v0.1.0
+  scikit-learn==0.24.1
+  typer==0.3.2
+
+[options.packages.find]
+exclude =
+	build*
+	docs*
+	tests*
+
+[options.extras_require]
+dev =
+  black==20.8b1
+  flake8==3.8.4
+  flake8-docstrings==1.5.0
+  isort==5.7.0
+  mkdocs==1.1.2
+  mkdocstrings==0.14.0
+  mkdocs-material==6.2.8
+  mypy==0.800
+  pre-commit==2.10.1
+  pydocstyle==5.1.1
+  pymdown-extensions==8.1.1
+  pytest==6.2.2
+
+[options.entry_points]
+console_scripts =
+    pyodi = pyodi.cli:app

requirements/build.txt

@@ -1,106 +1,4 @@
-"""Pyodi setup."""
-from setuptools import find_namespace_packages, setup
-
-MODULE_NAME = "pyodi"
-PACKAGE_NAME = "pyodi"
-VERSION = "0.0"
-
-
-def parse_requirements(fname="requirements.txt", with_version=True):
-    """Parse the package dependencies listed in a requirements file.
-
-    Args:
-        fname (str): path to requirements file
-        with_version (bool, default=False): if True include version specs
-    Returns:
-        List[str]: list of requirements items
-    CommandLine:
-        python -c "import setup; print(setup.parse_requirements())"
-    """
-    import re
-    import sys
-    from os.path import exists
-
-    require_fpath = fname
-
-    def parse_line(line):
-        """Parse information from a line in a requirements text file."""
-        if line.startswith("-r "):
-            # Allow specifying requirements in other files
-            target = line.split(" ")[1]
-            for info in parse_require_file(target):
-                yield info
-        else:
-            info = {"line": line}
-            if line.startswith("-e "):
-                info["package"] = line.split("#egg=")[1]
-            elif "@git+" in line:
-                info["package"] = line
-            else:
-                # Remove versioning from the package
-                pat = "(" + "|".join([">=", "==", ">"]) + ")"
-                parts = re.split(pat, line, maxsplit=1)
-                parts = [p.strip() for p in parts]
-
-                info["package"] = parts[0]
-                if len(parts) > 1:
-                    op, rest = parts[1:]
-                    if ";" in rest:
-                        # Handle platform specific dependencies
-                        # http://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-platform-specific-dependencies
-                        version, platform_deps = map(str.strip, rest.split(";"))
-                        info["platform_deps"] = platform_deps
-                    else:
-                        version = rest  # NOQA
-                    info["version"] = (op, version)
-            yield info
-
-    def parse_require_file(fpath):
-        with open(fpath, "r") as f:
-            for line in f.readlines():
-                line = line.strip()
-                if line and not line.startswith("#"):
-                    for info in parse_line(line):
-                        yield info
-
-    def gen_packages_items():
-        if exists(require_fpath):
-            for info in parse_require_file(require_fpath):
-                parts = [info["package"]]
-                if with_version and "version" in info:
-                    parts.extend(info["version"])
-                if not sys.version.startswith("3.4"):
-                    # apparently package_deps are broken in 3.4
-                    platform_deps = info.get("platform_deps")
-                    if platform_deps is not None:
-                        parts.append(";" + platform_deps)
-                item = "".join(parts)
-                yield item
-
-    packages = list(gen_packages_items())
-    return packages
-
+import setuptools
 
 if __name__ == "__main__":
-    setup(
-        name=PACKAGE_NAME,
-        version=VERSION,
-        description="Object Detection Insights",
-        author="Pyodi",
-        keywords="computer vision, object detection",
-        url="https://github.com/pyodi/pyodi",
-        packages=find_namespace_packages(
-            include="{}.*".format(MODULE_NAME), exclude=["tests", "logs"]
-        ),
-        include_package_data=True,
-        license="MIT License",
-        platforms="any",
-        python_requires=">=3.7",
-        setup_requires=parse_requirements("requirements/build.txt"),
-        tests_require=parse_requirements("requirements/dev.txt"),
-        install_requires=parse_requirements("requirements/runtime.txt"),
-        extras_require={"all": parse_requirements("requirements.txt")},
-        ext_modules=[],
-        zip_safe=False,
-        entry_points={"console_scripts": ["pyodi = pyodi.cli:app"]},
-    )
+    setuptools.setup()