Initial commit

Author: ywolff

.circleci/config.yml

@@ -0,0 +1,109 @@
+version: 2.1
+
+orbs:
+
+jobs:
+  install:
+    working_directory: ~/project-name
+    docker:
+      - image: circleci/python:3.9.7
+    steps:
+      - checkout
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+      - run:
+          name: Update Poetry to version 1.1.10
+          command: |
+            curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python - --version 1.1.10
+      - run:
+          name: Install dependencies
+          command: |
+            source /home/circleci/.poetry/env
+            poetry run pip install --upgrade pip
+            poetry install
+      - save_cache:
+          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+          paths:
+            - /home/circleci/.cache/pypoetry/virtualenvs
+            - /home/circleci/.poetry/env
+
+  test:
+    working_directory: ~/project-name
+    docker:
+      - image: circleci/python:3.9.7
+    steps:
+      - checkout
+      - restore_cache:
+          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+      - run:
+          name: run pytest
+          command: |
+            source /home/circleci/.poetry/env
+            make test
+      - store_test_results:
+          path: tests-results.xml
+      - store_artifacts:
+          path: htmlcov
+
+  black:
+    working_directory: ~/project-name
+    docker:
+      - image: circleci/python:3.9.7
+    steps:
+      - checkout
+      - restore_cache:
+          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+      - run:
+          name: run black
+          command: |
+            source /home/circleci/.poetry/env
+            make black
+
+  lint:
+    working_directory: ~/project-name
+    docker:
+      - image: circleci/python:3.9.7
+    steps:
+      - checkout
+      - restore_cache:
+          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+      - run:
+          name: run pylint
+          command: |
+            source /home/circleci/.poetry/env
+            make lint
+
+  isort:
+    working_directory: ~/project-name
+    docker:
+      - image: circleci/python:3.9.7
+    steps:
+      - checkout
+      - restore_cache:
+          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+      - run:
+          name: run isort
+          command: |
+            source /home/circleci/.poetry/env
+            make isort
+
+
+workflows:
+  version: 2
+  project-name:
+    jobs:
+      - install
+      - test:
+          requires:
+            - install
+      - lint:
+          requires:
+            - install
+      - black:
+          requires:
+            - install
+      - isort:
+          requires:
+            - install

.gitignore

@@ -0,0 +1,19 @@
+# byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# unit tests / coverage reports
+/tests-results.xml
+/.coverage
+/coverage.xml
+/htmlcov/
+
+# pyenv
+/.python-version
+
+# IDE
+.idea/
+.vscode/
+
+# macOS
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.0.1
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: check-json
+- repo: local
+  hooks:
+  - id: black
+    name: Formatting (black)
+    entry: poetry run black
+    language: system
+    types: [python]
+    stages: [commit]
+  - id: lint
+    name: Linter (pylint)
+    entry: poetry run pylint
+    language: system
+    types: [python]
+    stages: [commit]
+  - id: isort
+    name: Ordering imports (isort)
+    entry: poetry run isort
+    language: system
+    types: [python]
+    stages: [commit]
+  - id: test
+    name: Unit tests (pytest)
+    entry: make test
+    pass_filenames: false
+    language: system
+    types: [python]
+    stages: [push]

Makefile

@@ -0,0 +1,11 @@
+test:
+	poetry run pytest tests --cov src --cov-report=html --junit-xml=tests-results.xml
+
+black:
+	poetry run black . --check
+
+lint:
+	poetry run pylint src tests
+
+isort:
+	poetry run isort . --check

README.md

@@ -0,0 +1,77 @@
+# {project-name}
+
+{project-description}
+
+## Installation
+
+To install this project, you need `Python 3.9.7`.
+The recommended way to install it is using [pyenv](https://github.com/pyenv/pyenv).
+
+### Install poetry
+
+```bash
+python -m pip install --upgrade pip
+pip install poetry==1.1.10
+```
+
+### Install requirements through poetry
+
+```bash
+poetry install --no-root
+```
+
+### Install git hooks (running before commit and push commands)
+
+```bash
+poetry run pre-commit install -t pre-commit
+poetry run pre-commit install -t pre-push
+```
+
+## Testing
+
+To run unit tests, run `pytest` with:
+```bash
+poetry run pytest tests --cov src
+```
+or
+```bash
+make test
+```
+
+## Formatting and static analysis
+
+### Code formatting with `black`
+
+To check code formatting, run `black` with:
+```bash
+poetry run black . --check
+```
+or
+```bash
+make black
+```
+
+You can also [integrate it to your IDE](https://black.readthedocs.io/en/stable/integrations/editors.html) to reformat
+your code each time you save a file.
+
+### Static analysis
+
+To run static analysis, run `pylint` with:
+```bash
+poetry run pylint src tests
+```
+or
+```bash
+make lint
+```
+
+### Imports ordering
+
+To check imports ordering, run `isort` with:
+```bash
+poetry run isort . --check
+```
+or
+```bash
+make isort
+```