Merge branch 'sihrc:main' into main

sihrc · web-flow · commit 5daa1ca48c2c · 2023-11-08T17:10:49.000-05:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.2.0
+    hooks:
+      - id: autoflake
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+        args: ["--profile", "black"]
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.4.1" # Use the sha / tag you want to point at
+    hooks:
+      - id: mypy
+        pass_filenames: false
+        args: ["--config-file", "pyproject.toml"]
diff --git a/README.md b/README.md
@@ -2,38 +2,45 @@
 
 This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template used to generate Python 3.10+ poetry projects.
 
-
 ## Features
+
 #### Poetry
+
 local directory installation for vscode interpreter magic.
 
 #### Docker
+
 Dockerfile with python 3.10 base image and package installation
 
 #### Pre-commit
+
 Python's Isort for import formatting
 Python's Black for strict formatting
 
 #### vscode settings (optional)
+
 VSCode settings that use black and the local poetry python package for auto-completes and module discovery
 
 #### dotenv loading (optional)
-For application type packages that have .env provided runtime configurations
 
+For application type packages that have .env provided runtime configurations
 
 ## Installation
+
 ```bash
 pip3 install cookiecutter
 ```
 
 ## Usage
+
 ```bash
 cookiecutter gh:IndicoDataSolutions/cookiecutter-poetry-py3-10
 ```
 
 The cookiecutter generation hooks will automatically setup all features and dependency necessary for this project.
 
 ## Pre-commit Hooks
+
 ```yaml
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -53,3 +60,26 @@ repos:
     hooks:
       - id: black
 ```
+
+## Private Repos
+
+There is an option to enable ssh mounting to the docker build process that allows poetry to install private github repositories added to the pyproject.toml like so:
+
+```toml
+lib_name = {git = "ssh://git@github.com/user_or_org/lib_name.git", branch = "main", tag="0.1.0", version=0.1.0}
+```
+
+It requires `SSH_AUTH_SOCK` environment variable to be set, which can be done with the following command:
+
+```bash
+eval $(ssh-agent)
+```
+
+It also requires the keys you want to use for SSH access to be tracked in the ssh agent. If you don't have these setup, you can add them like so:
+
+```bash
+ssh-add -L # lists keys currently added
+ssh-add [optional key]
+```
+
+In order to have ssh-agent & keys automatically added, you can follow the instructions [here](https://unix.stackexchange.com/a/90869)
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -1,10 +1,8 @@
 {
-    "author": "sudocoder dev",
-    "email": "dev@sudocodes.dev",
-    "project_name": "Poetry Python 3.10 Library",
-    "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
-    "project_description": "Cut from cookiecutter-poetry-py3-10",
-    "version": "0.1.0",
-    "use_vscode": "y",
-    "use_dotenv": "y"
-}
+  "author": "Cookie Loving Engineer",
+  "email": "ilovecookies@imanengineer.io",
+  "project_name": "Poetry Python 3.10 Library",
+  "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
+  "project_description": "Cut from cookiecutter-poetry-py3-10",
+  "version": "0.1.0"
+}
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -1,38 +1,22 @@
 #! /usr/bin/env python
-import io
 import json
 import logging
-import os
 import sys
 import typing as t
-from contextlib import redirect_stdout
-from multiprocessing import Process
 from pathlib import Path
 
-from poetry.console import Application
+import sh
 
 logging.basicConfig(stream=sys.stdout, level=logging.INFO)
 
 
 def run_poetry_command(*args_list: t.Iterable[str]):
-    app = Application()
-    app.config.set_terminate_after_run(False)
-    output_buffer = io.StringIO()
-
-    with redirect_stdout(output_buffer):
-        sys.argv[1:] = args_list
-        logging.info(f"Poetry command: {' '. join(args_list)}")
-        app.run()
-
-    stdout = output_buffer.getvalue()
-
-    # remove exit code
-    return stdout.split()
+    return str(sh.poetry(*args_list))
 
 
 def try_remove(path: t.Union[str, Path]):
     # Coerce into path obj
-    path: Path = Path(path)
+    path = Path(path)
 
     # Delete either file or dir (true if exists)
     if path.is_file():
@@ -58,7 +42,7 @@ def update_json(
     Returns:
         settings_json (t.Dict): updated settings dictionary
     """
-    path: Path = Path(path)
+    path = Path(path)
     if not path.is_file():
         raise ValueError(f"Invalid path to json file {path}")
 
@@ -74,49 +58,25 @@ def update_json(
 
 
 def main():
-    os.system("git init")
-    os.system("git checkout -b main")
+    sh.git("init")
+    sh.git.checkout("-b", "main")
 
     # Commands to run
     for command in (
-        # ("config", "virtualenvs.in-project", "true", "--local"),
+        (
+            "config",
+            "virtualenvs.in-project",
+            "true",
+        ),
+        ("add", "--dev", "pytest", "black", "isort", "ipdb"),
         ("update",),
         ("install",),
     ):
         run_poetry_command(*command)
 
-    # TODO: Handle vscode / dotenv options
-    if "{{ cookiecutter.use_vscode }}" == "y":
-        logging.info("Setting up vscode python interpreter path")
-
-        # Fetch path to python interpreter for this poetry env
-        path = run_poetry_command("env", "info", "--path")[0]
-
-        logging.info(f"Setting python interpreter path to {path}")
-
-        # Add environment python interpreter to vscode settings.json
-        updated_settings = update_json(
-            Path(".vscode", "settings.json"), {"python.defaultInterpreterPath": path}
-        )
-        logging.info(f"vscode settings successfully updated {updated_settings}")
-    else:
-        logging.info("No vscode: deleting .vscode settings directory")
-        # Remove .vscode/
-        try_remove(".vscode")
-
-    if "{{ cookiecutter.use_dotenv }}" != "y":
-        # Remove .env & config.py
-        logging.info("No dotenv: deleting boilerplate .env and config.py")
-        try_remove("{{ cookiecutter.project_slug }}", "config.py")
-
-    with open(".gitignore", "a") as f:
-        f.write(".vscode/\n")
-
-    p = Process(target=run_poetry_command, args=("run", "pre-commit", "install", "-f"))
-    p.start()
-    p.join()
-
-    os.system("git add -A; git commit -m 'Cut a cookie from a cookiecutter'")
+    getattr(sh, "pre-commit").install("-f")
+    sh.git.add("-A")
+    sh.git.commit("-m", "'Cut a cookie from a cookiecutter'")
 
 
 if __name__ == "__main__":
diff --git a/{{cookiecutter.project_slug}}/.dockerignore b/{{cookiecutter.project_slug}}/.dockerignore
@@ -0,0 +1,16 @@
+.git/
+
+build
+dist
+*.egg-info
+*.egg/
+*.pyc
+*.swp
+
+.tox
+.coverage
+html/*
+__pycache__
+
+# Compiled Documentation
+docs/_build
diff --git a/{{cookiecutter.project_slug}}/.gitignore b/{{cookiecutter.project_slug}}/.gitignore
@@ -102,3 +102,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+poetry.lock
+.vscode/
diff --git a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
@@ -1,17 +1,27 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.2.0
+    hooks:
+      - id: autoflake
   - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort (python)
         args: ["--profile", "black"]
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.7.0
     hooks:
       - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.4.1" # Use the sha / tag you want to point at
+    hooks:
+      - id: mypy
+        pass_filenames: false
+        args: ["--config-file", "pyproject.toml"]
diff --git a/{{cookiecutter.project_slug}}/Dockerfile b/{{cookiecutter.project_slug}}/Dockerfile
@@ -1,19 +1,32 @@
-FROM python:3.10
+FROM python:3.10.6 as builder
+
+ENV PATH="/root/.local/bin:${PATH}"
+
+RUN curl -sSL https://install.python-poetry.org | python3 - && \
+    poetry self update --preview && \
+    poetry config virtualenvs.in-project true
+
+
+COPY pyproject.toml poetry.lock /venv/
+
+WORKDIR /venv/
+
+RUN poetry install
+
+FROM python:3.10.6
 
 LABEL version="{{cookiecutter.version}}"
 LABEL author="{{cookiecutter.author}}"
 LABEL email="{{cookiecutter.email}}"
 LABEL description="{{cookiecutter.project_description}}"
 
-ENV PATH=/{{cookiecutter.project_slug}}/bin:/root/.poetry/bin:${PATH}
+ENV PYTHONPATH=/{{cookiecutter.project_slug}} PATH=/venv/.venv/bin:/{{cookiecutter.project_slug}}/bin:/{{cookiecutter.project_slug}}/scripts:${PATH}
+COPY --from=builder /venv /venv
 
-RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
+RUN apt update
 
-COPY . /{{cookiecutter.project_slug}}
-WORKDIR /{{cookiecutter.project_slug}}
+WORKDIR /{{ cookiecutter.project_slug }}
+COPY . /{{ cookiecutter.project_slug }}
 
-# no need for virtualenv in docker
-RUN poetry config virtualenvs.create false \
-    && poetry install --no-interaction --no-ansi
 
-CMD ["bash"]
+ENTRYPOINT [ "bash" ]
diff --git a/{{cookiecutter.project_slug}}/docker-compose.yaml b/{{cookiecutter.project_slug}}/docker-compose.yaml
@@ -0,0 +1,11 @@
+version: "3"
+
+services:
+  {{ cookiecutter.project_slug }}:
+    build: .
+    container_name: {{ cookiecutter.project_slug }}
+    env_file: .env
+    tty: true
+    entrypoint: ash
+    volumes:
+      - .:/{{ cookiecutter.project_slug }}
diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml
@@ -3,20 +3,16 @@ name = "{{ cookiecutter.project_name }}"
 version = "{{ cookiecutter.version }}"
 description = "{{cookiecutter.project_description}}"
 authors = ["{{cookiecutter.author}} <{{cookiecutter.email}}>"]
-packages = [ {include = "{{ cookiecutter.project_slug }}"}]
 
 [tool.poetry.dependencies]
 python = "^3.10"
-setuptools = "^57.4.0"
-pytest = {version = "^6.2.4", extras = ["test"]}
-{% if cookiecutter.use_dotenv == 'y' %}python-dotenv = "^0.19.2"{%- endif %}
 
-
-[tool.poetry.dev-dependencies]
-pytest = {version = "^6.2.4"}
-black = {version = "^22.3.0", allow-prereleases = true}
-isort = {version = "^5.10.1", allow-prereleases = true}
-ipdb = {version = "^0.13.9", allow-prereleases = true}
+[tool.poetry.group.dev.dependencies]
+ipdb = "^0.13.13"
+black = "^23.9.1"
+isort = "^5.12.0"
+pytest = "^7.4.2"
+pytest-asyncio = "^0.21.1"
 
 [tool.pytest.ini_options]
 addopts = "-ra -q"
diff --git a/{{cookiecutter.project_slug}}/setup.py b/{{cookiecutter.project_slug}}/setup.py
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/config.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/config.py
