Version 1.1.0

Author: quentinhaenn

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Version 1.1.0
+
+- Add `--setup` flag option to create either `setup.cfg` and `setup.py` or `pyproject.toml` file.
+- Deprecate `--pyproject`, `--setupcfg`, and `--setuppy` flags. Use `--setup` flag instead.

README.md

@@ -17,12 +17,9 @@ This is a simple python project initializer. It creates any file and directory s
 - [x] publish the package on pypi
 - [x] add a command line interface
 - [x] test it vanilla
-- [ ] Change options setuppy and setupcfg to setup
-- [ ] Change options pyproject to make setup a flag. If setup is true, then create setup.py and setup.cfg. If setup is false, then create pyproject.toml
-- [ ] Refactor a bit to make the code more readable
+- [x] Change options setuppy and setupcfg to setup
+- [x] Change options pyproject to make setup a flag. If setup is true, then create setup.py and setup.cfg. If setup is false, then create pyproject.toml
 - [ ] Cut the code into smaller functions if possible
-- [ ] Add skeleton template for setup.py, setup.cfg, and pyproject.toml with flake8, black and pylint
-- [ ] Add pytest to the skeleton template as a dev dependency
 
 
 ## DESCRIPTION

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyproject_init"
-version = "1.0.2"
+version = "1.1.0"
 requires-python = ">=3.9"
 dependencies = [
     "click",

pyproject_init/__init__.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 __title__ = "pyprojectinit"
-__version__ = "0.1.0"
+__version__ = "1.1.0"
 __author__ = "Quentin Haenn"
 __license__ = "MIT"
 __copyright__ = "Copyright 2024 Quentin Haenn"

pyproject_init/cli.py

@@ -38,44 +38,42 @@ def cli():
 
 
 @cli.command()
-@click.option("--setuppy", is_flag=True, help="Create a setup.py file")
-@click.option("--setupcfg", is_flag=True, help="Create a setup.cfg file")
-@click.option("--pyproject", is_flag=True, help="Create a pyproject.toml file")
+@click.option("--setup", is_flag=True, help="If set, create a setup.py and a setup.cfg file, if not creates pyproject.toml")
 @click.option("--git", is_flag=True, help="Initialize a git repository")
 @click.option("--virtualenv", is_flag=True, help="Create a virtualenv")
 @click.option("--docker", is_flag=True, help="Create a docker file")
 @click.option("--license", default="MIT", help="Choose the license type")
 @click.argument("project_name", required=True)
-def lib(setuppy, setupcfg, pyproject, git, virtualenv, docker, license, project_name):
+def lib(setup, git, virtualenv, docker, license, project_name):
     """
     Create a library project
     """
     echo("Creating a library project")
     project_root = os.getcwd()
     initializer = PyprojectInitializer(
-        project_name, project_root, "lib", setuppy, setupcfg, pyproject, git, virtualenv, docker, license
+        project_name, project_root, "lib", setup, git, virtualenv, docker, license
     )
     initializer.init()
     echo("Library project created")
 
 
 @cli.command()
-@click.option("--setuppy", is_flag=True, help="Create a setup.py file")
-@click.option("--setupcfg", is_flag=True, help="Create a setup.cfg file")
-@click.option("--pyproject", is_flag=True, help="Create a pyproject.toml file")
+@click.option("--setup",
+              is_flag=True,
+              help="If set, create a setup.py and a setup.cfg file, if not creates pyproject.toml")
 @click.option("--git", is_flag=True, help="Initialize a git repository")
 @click.option("--virtualenv", is_flag=True, help="Create a virtualenv")
 @click.option("--docker", is_flag=True, help="Create a docker file")
 @click.option("--license", default="MIT", help="Choose the license type")
 @click.argument("project_name", required=True)
-def app(setuppy, setupcfg, pyproject, git, virtualenv, docker, license, project_name):
+def app(setup, git, virtualenv, docker, license, project_name):
     """
     Create an application project
     """
     echo("Creating an application project")
     project_root = os.getcwd()
     initializer = PyprojectInitializer(
-        project_name, project_root, "app", setuppy, setupcfg, pyproject, git, virtualenv, docker, license
+        project_name, project_root, "app", setup, git, virtualenv, docker, license
     )
     initializer.init()
     echo("Application project created")

pyproject_init/pyproject_initializer.py

@@ -15,38 +15,35 @@ def __init__(
         project_name,
         project_root,
         project_type,
-        setuppy_needed=False,
-        setupcfg_needed=False,
-        pyproject_needed=False,
+        setup = False,
         git_needed=False,
         virtualenv_needed=False,
         docker_needed=False,
-        license="MIT",
+        license_name="MIT",
     ):
         self.project_name = project_name
-        self.project_root = project_root  # os.getcwd()
+        self.project_root = project_root
         self.project_path = os.path.join(self.project_root, self.project_name)
         self.project_type = project_type
-        self.setuppy = setuppy_needed
-        self.setupcfg = setupcfg_needed
-        self.pyproject = pyproject_needed
+        self.setup = setup
         self.git = git_needed
         self.virtualenv = virtualenv_needed
         self.docker = docker_needed
-        self.license = license
+        self.license_name = license_name
 
     def init(self):
         """
         Initialize the project
         """
-        files.create_base_files(self.project_root, self.license, self.setupcfg, self.setuppy, self.pyproject)
+        files.create_base_files(self.project_root, self.license_name, self.setup)
         if self.project_type == "lib":
             self.create_lib_project()
         elif self.project_type == "app":
             self.create_app_project()
 
         if self.git:
             self.init_git()
+            files.create_gitignore(self.project_root, self.project_name)
 
         if self.virtualenv:
             self.init_virtualenv()
@@ -70,13 +67,13 @@ def init_git(self):
         """
         Initialize the git repository
         """
-        subprocess.run(["git", "init"], cwd=self.project_root)
+        subprocess.run(["git", "init"], cwd=self.project_root, check=True)
 
     def init_virtualenv(self):
         """
         Initialize the virtual environment
         """
-        subprocess.run(["python3", "-m", "venv", self.project_name + "-env"], cwd=self.project_root)
+        subprocess.run(["python3", "-m", "venv", self.project_name + "-env"], cwd=self.project_root, check=True)
 
     def init_docker(self):
         """

pyproject_init/utils/projectfiles.py

@@ -7,14 +7,12 @@
 
 
 def create_base_files(
-    project_path, license_type="MIT", setupcfg_needed=False, setuppy_needed=False, pyproject_needed=False
-):
+    project_path, license_type="MIT", setup = False):
     """
     Create the base files for a project.
 
     This function creates the following base files:
     - README.md
-    - .gitignore
     - LICENSE
     - pyproject.toml (optional)
     - setup.cfg (optional)
@@ -25,13 +23,11 @@ def create_base_files(
     """
 
     _create_readme(project_path)
-    _create_gitignore(project_path)
     _create_license(project_path, license_type)
-    if setupcfg_needed:
+    if setup:
         _create_setupcfg(project_path, license_type)
-    if setuppy_needed:
         _create_setuppy(project_path, license_type)
-    if pyproject_needed:
+    else:
         _create_pyproject(project_path)
 
 
@@ -51,7 +47,7 @@ def _create_readme(project_path):
         readme.write("- License\n")
 
 
-def _create_gitignore(project_path):
+def create_gitignore(project_path, project_name):
     """
     _create_gitignore creates the .gitignore file
 
@@ -66,19 +62,22 @@ def _create_gitignore(project_path):
         gitignore.write("# pytest artifacts\n")
         gitignore.write("*.pyc\n")
         gitignore.write("__pycache__/\n")
+        gitignore.write(".pytest_cache/\n")
         gitignore.write("\n")
         gitignore.write("# Coverage\n")
         gitignore.write("htmlcov/\n")
         gitignore.write(".coverage\n")
-        gitignore.write(".pytest_cache/\n")
         gitignore.write("\n")
         gitignore.write("# Distribution\n")
         gitignore.write("build/\n")
         gitignore.write("dist/\n")
         gitignore.write(".eggs/\n")
+        gitignore.write("*.egg-info\n")
         gitignore.write("\n")
         gitignore.write("# Documentation source build\n")
         gitignore.write("doc/_build\n")
+        gitignore.write("# Virtual environment\n")
+        gitignore.write(project_path + project_name + "-env/\n")
 
 
 def _create_license(project_path, license_type="MIT"):

test/test_cli.py

@@ -19,9 +19,6 @@ def test_lib(self, runner, tmp_path):
         result = runner.invoke(
             lib,
             [
-                "--setuppy",
-                "--setupcfg",
-                "--pyproject",
                 "--git",
                 "--virtualenv",
                 "--docker",
@@ -33,12 +30,11 @@ def test_lib(self, runner, tmp_path):
         print(result.output)
         assert result.exit_code == 0
         assert os.path.isdir(os.path.join(tmp_path, "test_project"))
-        assert os.path.isfile(os.path.join(tmp_path, "setup.py"))
-        assert os.path.isfile(os.path.join(tmp_path, "setup.cfg"))
         assert os.path.isfile(os.path.join(tmp_path, "pyproject.toml"))
         assert os.path.isdir(os.path.join(tmp_path, "test_project-env"))
         assert os.path.isfile(os.path.join(tmp_path, "Dockerfile"))
         assert os.path.isdir(os.path.join(tmp_path, ".git"))
+        assert os.path.isfile(os.path.join(tmp_path, ".gitignore"))
         assert os.path.isfile(os.path.join(tmp_path, "LICENSE"))
         assert os.path.isfile(os.path.join(tmp_path, "README.md"))
 
@@ -48,9 +44,7 @@ def test_app(self, runner, tmp_path):
             app,
             [
                 "test_project",
-                "--setuppy",
-                "--setupcfg",
-                "--pyproject",
+                "--setup",
                 "--git",
                 "--virtualenv",
                 "--docker",
@@ -62,9 +56,9 @@ def test_app(self, runner, tmp_path):
         assert os.path.isdir(os.path.join(tmp_path, "test_project"))
         assert os.path.isfile(os.path.join(tmp_path, "setup.py"))
         assert os.path.isfile(os.path.join(tmp_path, "setup.cfg"))
-        assert os.path.isfile(os.path.join(tmp_path, "pyproject.toml"))
         assert os.path.isdir(os.path.join(tmp_path, "test_project-env"))
         assert os.path.isfile(os.path.join(tmp_path, "Dockerfile"))
         assert os.path.isdir(os.path.join(tmp_path, ".git"))
+        assert os.path.isfile(os.path.join(tmp_path, ".gitignore"))
         assert os.path.isfile(os.path.join(tmp_path, "LICENSE"))
         assert os.path.isfile(os.path.join(tmp_path, "README.md"))

test/test_projectfiles.py

@@ -22,7 +22,7 @@ def test_create_readme(self, tmp_path):
             assert "- License" in content
 
     def test_create_gitignore(self, tmp_path):
-        pfiles._create_gitignore(str(tmp_path))
+        pfiles.create_gitignore(str(tmp_path), "test_project")
         gitignore_path = os.path.join(str(tmp_path), ".gitignore")
         assert os.path.isfile(gitignore_path)
         with open(gitignore_path, "r") as gitignore:
@@ -99,11 +99,15 @@ def test_create_pyproject(self, tmp_path):
             assert 'requires = ["setuptools", "wheel"]\n' in content
             assert 'build-backend = "setuptools.build_meta"\n' in content
 
-    def test_create_base_files(self, tmp_path):
-        pfiles.create_base_files(str(tmp_path), "MIT", True, True, True)
+    def test_create_base_files_setup(self, tmp_path):
+        pfiles.create_base_files(str(tmp_path), "MIT", True)
         assert os.path.isfile(os.path.join(tmp_path, "README.md"))
-        assert os.path.isfile(os.path.join(tmp_path, ".gitignore"))
         assert os.path.isfile(os.path.join(tmp_path, "LICENSE"))
         assert os.path.isfile(os.path.join(tmp_path, "setup.cfg"))
         assert os.path.isfile(os.path.join(tmp_path, "setup.py"))
+    
+    def test_create_base_files_pyproject(self, tmp_path):
+        pfiles.create_base_files(str(tmp_path), "MIT", False)
+        assert os.path.isfile(os.path.join(tmp_path, "README.md"))
+        assert os.path.isfile(os.path.join(tmp_path, "LICENSE"))
         assert os.path.isfile(os.path.join(tmp_path, "pyproject.toml"))

test/test_pyproject.py

@@ -7,32 +7,30 @@
 
 class TestPyprojectInitializer:
     def test_init(self, tmp_path):
-        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, True, True, "MIT")
+        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib",True, True, True, True, "MIT")
         assert py_test.project_name == "test_project"
         assert py_test.project_root == str(tmp_path)
         assert py_test.project_path == os.path.join(str(tmp_path), "test_project")
         assert py_test.project_type == "lib"
-        assert py_test.setuppy is True
-        assert py_test.setupcfg is True
-        assert py_test.pyproject is True
+        assert py_test.setup is True
         assert py_test.git is True
         assert py_test.virtualenv is True
         assert py_test.docker is True
-        assert py_test.license is "MIT"
+        assert py_test.license_name is "MIT"
 
     def test_init_git(self, tmp_path):
-        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, True, True, "MIT")
+        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, "MIT")
         py_test.init_git()
         assert os.path.isdir(os.path.join(str(tmp_path), ".git"))
         subprocess.run(["rm", "-rf", os.path.join(str(tmp_path), ".git")], check=True)
 
     def test_init_virtualenv(self, tmp_path):
-        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, True, True, "MIT")
+        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, "MIT")
         py_test.init_virtualenv()
         assert os.path.isdir(os.path.join(str(tmp_path), "test_project-env"))
         subprocess.run(["rm", "-rf", os.path.join(str(tmp_path), "test_project-env")], check=True)
 
     def test_init_docker(self, tmp_path):
-        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, True, True, "MIT")
+        py_test = PyprojectInitializer("test_project", str(tmp_path), "lib", True, True, True, True, "MIT")
         py_test.init_docker()
         assert os.path.isfile(os.path.join(str(tmp_path), "Dockerfile"))