start implementing windows support

Author: a.pirogov

README.md

@@ -86,9 +86,12 @@ recommendations on the state of software citation in academic practice.
 
 ## Getting Started
 
+Make sure that you have a working Python interpreter in version at least 3.8,
+`git` and [`poetry`](https://python-poetry.org/docs/#installation) installed.
+
 To install the template, run `pip install fair-python-cookiecutter`.
 
-Now you can run the tool to generate a new Python project:
+Now you can use the tool to generate a new Python project:
 
 ```bash
 fair-python-cookiecutter YourProjectName

src/fair_python_cookiecutter/main.py

@@ -1,11 +1,87 @@
 """Main functions for controlling the template creation."""
 from pathlib import Path
+from shutil import which
 from typing import Any, Dict
 
 from cookiecutter.main import cookiecutter
 
 from .config import CookiecutterConfig, CookiecutterJson
-from .utils import TempDir, copy_template
+from .utils import TempDir, copy_template, run_cmd
+
+
+def check_prerequisites():
+    needed = ["git", "python", "pip", "poetry"]
+    for prg in needed:
+        if not which(prg):
+            print(f"Program '{prg}' was not found in your environment, cannot proceed!")
+            exit(1)
+
+
+def strip_yaml_header(file_contents: str):
+    """Given text file contents, remove YAML header bounded by '---' lines."""
+    content = file_contents.splitlines()
+    startidx = 1
+    if content and content[0] == "---":
+        startidx += 1
+        while not content[startidx - 1].startswith("---"):
+            startidx += 1
+    return "\n".join(content[startidx:])
+
+
+def create_gl_issue_template_from_gh(proj_root: Path):
+    """Given project path, create GitLab issue templates from GitHub ones."""
+    gh_templates = proj_root / ".github" / "ISSUE_TEMPLATE"
+    gl_templates = proj_root / ".gitlab" / "issue_templates"
+
+    gl_templates.mkdir(parents=True, exist_ok=True)
+    for file in gh_templates.glob("*"):
+        with open(gl_templates / file.name, "w") as f:
+            f.write(strip_yaml_header(open(file).read()))
+
+
+def remove_unneeded_code(proj_root: Path, conf: CookiecutterConfig):
+    """Remove code examples the user did not wish to have in the project."""
+    pkg = conf.fair_python_cookiecutter.project_package()
+    to_remove = []
+    if not conf.fair_python_cookiecutter.init_cli:
+        to_remove += [
+            (proj_root / "src" / pkg / "cli.py"),
+            (proj_root / "tests" / "test_cli.py"),
+        ]
+    if not conf.fair_python_cookiecutter.init_api:
+        to_remove += [
+            (proj_root / "src" / pkg / "api.py"),
+            (proj_root / "tests" / "test_api.py"),
+        ]
+    for file in to_remove:
+        if file.is_file():
+            file.unlink()
+
+
+def download_licenses(proj_root: Path, conf: CookiecutterConfig):
+    """Download all needed licenses and create main LICENSE file."""
+    # only install reuse/pipx if it is not found
+    reuse_cmd = "reuse --suppress-deprecation download --all"
+    if not which("reuse"):
+        reuse_cmd = "pipx run " + reuse_cmd
+        if not which("pipx"):
+            run_cmd("poetry run pip install pipx", cwd=proj_root)
+            reuse_cmd = "poetry run " + reuse_cmd
+    # download licenses
+    print(reuse_cmd, "root:", proj_root)
+    run_cmd(reuse_cmd, cwd=proj_root)
+    # copy main license over from resulting licenses directory
+    license_name = conf.fair_python_cookiecutter.project_license
+    license = Path(proj_root) / "LICENSE"
+    license.write_text((proj_root / "LICENSES" / f"{license_name}.txt").read_text())
+
+
+def finalize_repository(proj_root: Path, conf: CookiecutterConfig):
+    """Finalize instantiated repository based on configuration."""
+    # remove unneeded and create needed files
+    create_gl_issue_template_from_gh(proj_root)
+    remove_unneeded_code(proj_root, conf)
+    download_licenses(proj_root, conf)
 
 
 def create_repository(
@@ -19,6 +95,7 @@ def create_repository(
     cc_json = CookiecutterJson.from_config(conf)
     cc_args = cc_args or {}
 
+    check_prerequisites()
     with TempDir(keep=keep_on_fail) as tmp_root:
         copy_template(tmp_root, cookiecutter_json=cc_json)
         cookiecutter(
@@ -30,4 +107,6 @@ def create_repository(
             **cc_args,
         )
         repo_dir = output_dir / cc_json.project_slug
+        finalize_repository(repo_dir, conf)
+
         return repo_dir

src/fair_python_cookiecutter/template/hooks/post_gen_project.sh

@@ -1,61 +1,54 @@
-#!/usr/bin/env bash
-# Finalization of project template
-
-# create gitlab issue templates by stripping metadata from GH issue templates
-for file in .github/ISSUE_TEMPLATE/*; do
-    cat $file | awk -v x=0 '
-    {
-        if ( x > 1 )
-            { print }
-        if ( $1 ~ /^---/)
-            { x++; }
-    }' > .gitlab/issue_templates/$(basename $file)
-done
-
-# ----
-# remove unneeded demo code
-# {% if not cookiecutter.init_cli %}
-rm src/{{ cookiecutter.project_package }}/cli.py
-rm tests/test_cli.py
-# {% endif %}
-# {% if not cookiecutter.init_api %}
-rm src/{{ cookiecutter.project_package }}/api.py
-rm tests/test_api.py
-# {% endif %}
-# ----
-
-# finalize repo setup
-git init
-
-# make sure we are not in some venv (or poetry would just use that!)
+: # Magic to deactivate current Python venv (if one is enabled) in a cross-platform way
+: # See https://stackoverflow.com/questions/17510688/single-script-to-run-in-both-windows-batch-and-linux-bash
+:<<"::CMDLITERAL"
+: ----  code for cmd.exe  ----
+ECHO "TODO: cmd.exe code"
+: ----------------------------
+GOTO :COMMON
+::CMDLITERAL
+# ---- bash-specific code ----
 venv=$(python -c "import sys; print(sys.prefix if sys.base_prefix != sys.prefix else '')")
 if [[ -n "$venv" ]]; then
     echo WARNING: deactivating currently active virtual environment "$venv"
     source "$venv/bin/activate"  # make sure we have 'deactivate' available
     deactivate
 fi
+# ----------------------------
+:<<"::CMDLITERAL"
+:COMMON
+::CMDLITERAL
+: #All following code must be hybrid (work for bash and cmd.exe)
+: # ------------------------------------------------------------
+
+echo "Initializing the git repository ..."
+
+git init
+poetry install --with docs
+poetry run poe init-dev
 
-poetry install --with docs  # install everything into a new venv
-poetry run poe init-dev  # init git repo + register pre-commit
-poetry run pip install pipx  # install pipx into venv without adding it as dep
-poetry run pipx run reuse download --all  # get license files for REUSE compliance
-cp "LICENSES/{{ cookiecutter.project_license }}.txt" LICENSE  # copy over the main license
+echo "Creating CITATION.cff and codemeta.json using somesy ..."
 
-# create CITATION.cff and codemeta.json
 git add .
 poetry run pre-commit run somesy
 git add .
 
-# create first commit
+echo "Creating first commit ..."
+
 poetry run git commit \
     -m "generated project using fair-python-cookiecutter {{ cookiecutter._fpc_version }}" \
     -m "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
 
-# make sure that the default branch is called 'main'
+echo "Ensuring that the default branch is called 'main' ..."
+
 git branch -M main
 
-# sanity-check that main tasks all work
-poetry install --with docs
-poetry run poe lint --all-files
-poetry run poe test
-poetry run poe docs
+echo "All done! Your project repository is ready :)"
+
+
+: # TODO: only do following in test mode
+
+: # sanity-check that main tasks all work
+: # poetry install --with docs
+: # poetry run poe lint --all-files
+: # poetry run poe test
+: # poetry run poe docs

src/fair_python_cookiecutter/utils.py

@@ -1,6 +1,9 @@
 """Utilities for creation of template repository instances."""
 import json
+import platform
 import shutil
+import subprocess
+import sys
 from pathlib import Path
 from typing import Optional
 from uuid import uuid1
@@ -72,3 +75,23 @@ def copy_template(
             "Template root directory not identified, this must be a bug!"
         )
     return template_root
+
+
+def get_venv_path() -> Optional[Path]:
+    """Return path of venv, if we detect being inside one."""
+    return Path(sys.prefix) if sys.base_prefix != sys.prefix else None
+
+
+VENV_PATH: Optional[Path] = get_venv_path()
+"""If set, the path of the virtual environment this tool is running in."""
+
+
+def venv_activate_cmd(venv_path: Path):
+    if platform.system() != "Windows":
+        return "source " + str(venv_path / "bin" / "activate")
+    else:
+        return str(venv_path / "Scripts" / "activate")
+
+
+def run_cmd(cmd: str, cwd: Path = None):
+    subprocess.run(cmd.split(), cwd=cwd, check=True)  # noqa: S603