project_setup.py

# """Helps setup a new project based on this template."""
#
# import argparse
# import functools
# import os
# from pathlib import Path
# from typing import List, Tuple
#
# # this is GitPython
# import git
#
# TEMPLATE_PACKAGE_NAME = "levseq_dash"
# TEMPLATE_REPO_URL = "https://github.com/ssec-jhu/base-template"
# TEMPLATE_RTD = "ssec-jhu-base-template"
# TEMPLATE_CODECOV = "ssec-jhu/base-template"
#
# UPDATED_PYPROJECT_TOML = "pyproject.toml [project.urls] ✅"
# UPDATED_README = "Updated README.md ✅, but you need to add a token to the codecov badge!"
# UPDATED_DIR = "Renamed {old_dir} to {new_dir} ✅"
# UPDATED_FILE = "Updated levseq_dash to {levseq_dash} in {file_path} ✅"
# SETUP_COMPLETE = "{levseq_dash} setup complete! 🎉🎉🎉\n"
#
#
# def make_name_safe(name: str) -> str:
#     """Makes a string safe to use as a package name."""
#     return name.lower().replace(" ", "_").replace("-", "_")
#
#
# def valid_file_predicate(file_path: Path) -> bool:
#     """Checks if a file is valid for modification."""
#     is_valid_extension = file_path.suffix not in [
#         # images
#         ".png",
#         ".jpg",
#         ".jpeg",
#     ]
#     not_ds_store = file_path.name != ".DS_Store"
#     not_this = file_path.name != Path(__file__).name
#
#     return is_valid_extension and not_ds_store and not_this
#
#
# def get_package_name(
#     repo_url: str,
# ) -> str:
#     """Guesses the package name from the repo URL."""
#     return make_name_safe(Path(repo_url).stem)
#
#
# def replace_file_contents(
#     pairs_to_replace: List[Tuple[str, str]],
#     file_path: Path,
# ) -> bool:
#     """Replaces the contents of a file.
#
#     pairs_to_replace (List[Tuple[str, str]]): A list of tuples where the first
#         element is the string to replace and the second element is the new string
#     file_path (Path): The path to the file to modify
#
#     Returns:
#         bool: True if the file was modified, False otherwise
#     """
#     with open(file_path, "r") as f:
#         content = f.read()
#
#     new_content = functools.reduce(lambda x, y: x.replace(*y), pairs_to_replace, content)
#
#     if new_content != content:
#         with open(file_path, "w") as f:
#             f.write(new_content)
#         return True
#
#     return False
#
#
# def self_destruct(parent_dir: Path = Path(".")) -> None:
#     """Deletes this file and its tests."""
#     os.remove(parent_dir / Path(__file__).name)
#     os.remove(parent_dir / Path("tests/test_project_setup.py"))
#
#     # remove the dependency on GitPython
#     for env in ["dev", "test"]:
#         with open(parent_dir / Path(f"requirements/{env}.txt"), "r") as f:
#             requirements = list(map(lambda line: line.strip(), f.readlines()))
#
#         requirements = list(filter(lambda x: "GitPython" not in x, requirements))
#         with open(parent_dir / Path(f"requirements/{env}.txt"), "w") as f:
#             f.write("\n".join(requirements))
#
#
# def rtd_project_guess(
#     repo_url: str,
# ) -> str:
#     """Guesses the RTD project name from the repo URL."""
#     return Path(repo_url).stem
#
#
# def codecov_project_guess(
#     repo_url: str,
# ) -> str:
#     """Guesses the codecov project name from the repo URL."""
#     return "/".join(Path(repo_url).parts[-2:]).replace(".git", "")
#
#
# def run_setup(
#     repo_url: str,
#     package_name: str,
#     repo: git.Repo = git.Repo(),
#     commit_as_you_go: bool = True,
# ) -> None:
#     """Helper to setup a new project based on this template.
#
#     It does the following things:
#     1. Updates the pyproject.toml and README.md files
#     2. Renames the levseq_dash directory to a python safe version of the
#        repo name
#     3. Updates the levseq_dash and <levseq_dash> in all files to a python safe
#        version of the repo name
#
#     Args:
#         repo_url (str): The URL of the repo
#         package_name (str): The name of the package
#         repo (git.Repo): The git repo to use
#         commit_as_you_go (bool): Whether to commit after each step
#
#     Returns:
#         None
#     """
#
#     def commit_func(message: str) -> None:
#         repo.git.commit(
#             *list(
#                 filter(
#                     lambda arg: len(arg) > 0,
#                     [
#                         "--dry-run" if not commit_as_you_go else "",
#                         "-qam",
#                         message,
#                     ],
#                 )
#             )
#         )
#
#     # Step 1: Update the pyproject.toml and README.md ==========================
#     rtd_guess = rtd_project_guess(repo_url)
#     codecov_guess = codecov_project_guess(repo_url)
#
#     pyproject_toml_replacement_pairs = [
#         (TEMPLATE_REPO_URL, repo_url),
#     ]
#     if replace_file_contents(
#         pyproject_toml_replacement_pairs,
#         Path(repo.working_dir) / Path("pyproject.toml"),
#     ):
#         print(UPDATED_PYPROJECT_TOML)
#
#     readme_replacement_pairs = [
#         (TEMPLATE_REPO_URL, repo_url),
#         (TEMPLATE_RTD, rtd_guess),
#         (TEMPLATE_CODECOV, codecov_guess),
#     ]
#     if replace_file_contents(
#         readme_replacement_pairs,
#         Path(repo.working_dir) / Path("README.md"),
#     ):
#         print(UPDATED_README)
#
#     commit_func("updated pyproject.toml and README.md")
#
#     # Step 2: Update the levseq_dash in all files =============================
#
# # filter out files that we don't want to modify files_to_check = list( filter( valid_file_predicate, map(lambda f:
# Path(repo.working_dir) / Path(f), repo.git.ls_tree("-r", "--name-only", "HEAD").split("\n")), ) )
#
#     # order matters, replace the bracketed version first
#     package_name_replacement_pairs = [
#         ("<" + TEMPLATE_PACKAGE_NAME + ">", package_name),
#         (TEMPLATE_PACKAGE_NAME, package_name),
#     ]
#     for file_path in files_to_check:
#         # only print positive results
#         if replace_file_contents(package_name_replacement_pairs, file_path):
#             print(UPDATED_FILE.format(package_name=package_name, file_path=file_path))
#
#     # Step 3: Rename the levseq_dash directory ================================
#     repo.git.mv(TEMPLATE_PACKAGE_NAME, package_name)
#     repo.git.commit("-m", f"renamed dir {TEMPLATE_PACKAGE_NAME} to {package_name}")
#     print(UPDATED_DIR.format(old_dir=TEMPLATE_PACKAGE_NAME, new_dir=package_name))
#
#     commit_func("renamed dir {TEMPLATE_PACKAGE_NAME} to {levseq_dash}")
#
#     self_destruct(Path(repo.working_dir))
#
#     commit_func("removed base-template setup files")
#
#     print(SETUP_COMPLETE.format(package_name=package_name))
#
#
# if __name__ == "__main__":
#     parser = argparse.ArgumentParser()
#     parser.add_argument(
#         "--repo_url",
#         type=str,
#         default="",
#         help="The URL of the repo, we get this from git, so you probably don't need to set this.",
#     )
#     parser.add_argument(
#         "--levseq_dash",
#         type=str,
#         default="",
#         help="The name of the package, we guess this from the repo URL. If you want to override it, set it here.",
#     )
#     parser.add_argument(
#         "--commit_as_you_go",
#         action=argparse.BooleanOptionalAction,
#         help="Whether to commit after each step. Default is False.",
#     )
#     arguments = parser.parse_args()
#
#     repo_url = arguments.repo_url or git.Repo().remotes.origin.url
#     package_name = arguments.package_name or get_package_name(repo_url)
#     run_setup(
#         repo_url=repo_url,
#         package_name=package_name,
#         commit_as_you_go=bool(arguments.commit_as_you_go),
#     )