initial commit

Author: FrancescoSaverioZuppichini

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test WorkFlow
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+      - name: 🛎️ Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: 🦾 Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[dev]"
+      - name: 🧹 Lint with flake8
+        run: |
+          make check_code_quality
+      - name: 🧪 Test
+        run: "python -m pytest ./test"

Makefile

@@ -0,0 +1,17 @@
+.PHONY: style check_code_quality
+
+export PYTHONPATH = .
+check_dirs := src
+
+style:
+	black  $(check_dirs)
+	isort --profile black $(check_dirs)
+
+check_code_quality:
+	black --check $(check_dirs)
+	isort --check-only --profile black $(check_dirs)
+	# stop the build if there are Python syntax errors or undefined names
+	flake8 $(check_dirs) --count --select=E9,F63,F7,F82 --show-source --statistics
+	# exit-zero treats all errors as warnings. E203 for black, E501 for docstring, W503 for line breaks before logical operators 
+	flake8 $(check_dirs) --count --max-line-length=88 --exit-zero  --ignore=D --extend-ignore=E203,E501,W503  --statistics
+	

README.md

@@ -1,2 +1,62 @@
-# template-python
-A template repo holding our common setup for a python project
+# Python Template 🐍
+A template repo holding our common setup for a python project.
+
+## Installation
+
+You can install the package using pip
+
+```
+pip install -e .
+```
+
+or for development
+
+```
+pip install -e ".[dev]"
+```
+
+## Structure
+
+The project has the following structure
+
+```
+├── .github
+│   └── workflows
+│       └── test.yml # holds our github action config 
+├── .gitignore
+├── Makefile
+├── README.md
+├── setup.py
+├── src
+│   ├── __init__.py 
+│   ├── hello.py 
+└── test 
+    └── test_hello.py
+```
+
+### Code Quality 🧹
+
+We provide two handy commands inside the `Makefile`, namely:
+
+- `make style` to format the code
+- `make check_code_quality` to check code quality (PEP8 basically)
+
+So far, **there is no linting with mypy`. See [issue](link) 
+
+### Tests 🧪
+
+[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.
+
+### CI/CD
+
+We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.
+
+
+# Q&A
+
+## Why no cookiecutter?
+This is a template repo, it's meant to be used inside GitHub upon repo creation.
+
+## Why reinvent the wheel?
+
+There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.

setup.py

@@ -0,0 +1,29 @@
+import setuptools
+from setuptools import find_packages
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="template-python",  # Replace with your own username
+    version="0.0.1",
+    author="Roboflow",
+    author_email="[email protected]",
+    description="<INSERT_DESCRIPTION>",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="<INSERT_URL>",
+    install_requires=[
+      # list your requires
+    ],
+    packages=find_packages(exclude=("tests",)),
+    extras_require={
+        "dev": ["flake8", "black==22.3.0", "isort"],
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.7",
+)

src/__init__.py

@@ -0,0 +1,2 @@
+def hello() -> str:
+    return "World"

src/hello.py

@@ -0,0 +1,6 @@
+from src.hello import hello
+
+
+def test_hello():
+    res = hello()
+    assert res == "World"