pdm init command

Author: frostming

pdm/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.2"
+__version__ = "0.0.3"

pdm/cli/actions.py

@@ -1,4 +1,5 @@
 import itertools
+import shutil
 from typing import Dict, Iterable, Optional, Sequence
 
 import halo
@@ -292,16 +293,53 @@ def do_list(project: Project) -> None:
 
 
 def do_build(
-    project: Project, sdist: bool = True, wheel: bool = True, dest: str = "dist"
+    project: Project,
+    sdist: bool = True,
+    wheel: bool = True,
+    dest: str = "dist",
+    clean: bool = True,
 ):
     if not wheel and not sdist:
         context.io.echo("All artifacts are disabled, nothing to do.")
         return
     ireq = project.make_self_candidate(False).ireq
     ireq.source_dir = "."
+    if clean:
+        shutil.rmtree(dest, ignore_errors=True)
     if sdist:
         with SdistBuilder(ireq) as builder:
             builder.build(dest)
     if wheel:
         with WheelBuilder(ireq) as builder:
             builder.build(dest)
+
+
+def do_init(
+    project: Project,
+    name: str = "",
+    version: str = "",
+    license: str = "MIT",
+    author: str = "",
+    email: str = "",
+) -> None:
+    data = {
+        "tool": {
+            "pdm": {
+                "name": name,
+                "version": version,
+                "description": "",
+                "author": f"{author} <{email}>",
+                "license": license,
+                "homepage": "",
+                "dependencies": tomlkit.table(),
+                "dev-dependencies": tomlkit.table(),
+            }
+        },
+        "build-system": {"requires": "pdm", "build-backend": "pdm.builders.api"},
+    }
+    if not project.pyproject:
+        project._pyproject = data
+    else:
+        project._pyproject.setdefault("tool", {})["pdm"] = data["tool"]["pdm"]
+        project._pyproject["build-system"] = data["build-system"]
+    project.write_pyproject()

pdm/cli/commands.py

@@ -17,6 +17,7 @@
 from pdm.context import context
 from pdm.exceptions import CommandNotFound
 from pdm.project import Project
+from pdm.utils import get_user_email_from_git
 
 pass_project = click.make_pass_decorator(Project, ensure=True)
 context_settings = {"ignore_unknown_options": True, "allow_extra_args": True}
@@ -213,6 +214,36 @@ def list_(project):
     "--no-wheel", "wheel", default=True, flag_value=False, help="Don't build wheels."
 )
 @click.option("-d", "--dest", default="dist", help="Target directory to put artifacts.")
+@click.option(
+    "--no-clean",
+    "clean",
+    default=True,
+    flag_value=False,
+    help="Do not clean the target directory.",
+)
+@pass_project
+def build(project, sdist, wheel, dest, clean):
+    actions.do_build(project, sdist, wheel, dest, clean)
+
+
+@cli.command(help="Initialize a pyproject.toml for PDM.")
 @pass_project
-def build(project, sdist, wheel, dest):
-    actions.do_build(project, sdist, wheel, dest)
+def init(project):
+    if project.pyproject_file.exists():
+        context.io.echo(
+            "{}".format(
+                context.io.cyan("pyproject.toml already exists, update it now.")
+            )
+        )
+    else:
+        context.io.echo(
+            "{}".format(context.io.cyan("Creating a pyproject.toml for PDM..."))
+        )
+    name = click.prompt(f"Project name", default=project.root.name)
+    version = click.prompt("Project version", default="0.0.0")
+    license = click.prompt("License(SPDX name)", default="MIT")
+
+    git_user, git_email = get_user_email_from_git()
+    author = click.prompt(f"Author name", default=git_user)
+    email = click.prompt(f"Author email", default=git_email)
+    actions.do_init(project, name, version, license, author, email)

pdm/installers.py

@@ -131,7 +131,7 @@ def compare_with_working_set(self) -> Tuple[List[str], List[str], List[str]]:
                 dist = working_set[key][0]
                 if can.marker and not can.marker.evaluate(environment):
                     to_remove.append(key)
-                elif _is_dist_editable(dist) or dist.version != can.version:
+                elif not _is_dist_editable(dist) and dist.version != can.version:
                     # XXX: An editable distribution is always considered as consistent.
                     to_update.append(key)
         to_add = list(

pdm/project/core.py

@@ -77,7 +77,7 @@ def __repr__(self) -> str:
     @property
     def pyproject(self):
         # type: () -> Container
-        if not self._pyproject:
+        if not self._pyproject and self.pyproject_file.exists():
             data = tomlkit.parse(self.pyproject_file.read_text("utf-8"))
             self._pyproject = data
         return self._pyproject
@@ -197,7 +197,7 @@ def write_lockfile(self, toml_data: Container, show_message: bool = True) -> Non
         self._lockfile = None
 
     def make_self_candidate(self, editable: bool = True) -> Candidate:
-        req = parse_requirement(".", editable)
+        req = parse_requirement(self.root.as_posix(), editable)
         req.name = self.meta.name
         return Candidate(
             req, self.environment, name=self.meta.name, version=self.meta.version
@@ -283,21 +283,6 @@ def write_pyproject(self, show_message: bool = True) -> None:
             context.io.echo("Changes are written to pyproject.toml.")
         self._pyproject = None
 
-    def init_pyproject(self) -> None:
-        if not self._pyproject:
-            self._pyproject = {}
-        self._pyproject.update(
-            {
-                "tool": {
-                    "pdm": {
-                        "dependencies": tomlkit.table(),
-                        "dev-dependencies": tomlkit.table(),
-                    }
-                }
-            }
-        )
-        self.write_pyproject()
-
     @property
     @pyproject_cache
     def meta(self) -> PackageMeta:

pdm/ui.py

@@ -21,7 +21,7 @@ def __init__(self, verbosity: int = NORMAL, disable_colors: bool = False) -> Non
             setattr(self, color, functools.partial(self._style, fg=color))
 
     def disable(self) -> None:
-        self.disable_colors = False
+        self.disable_colors = True
 
     def set_verbosity(self, verbosity: int) -> None:
         self.verbosity = verbosity

pdm/utils.py

@@ -329,17 +329,39 @@ def get_pep508_environment(executable: str) -> Dict[str, Any]:
     return json.loads(subprocess.check_output(args))
 
 
-def convert_hashes(hases: Dict[str, str]) -> Dict[str, List[str]]:
+def convert_hashes(hashes: Dict[str, str]) -> Dict[str, List[str]]:
     """Convert Pipfile.lock hash lines into InstallRequirement option format.
 
     The option format uses a str-list mapping. Keys are hash algorithms, and
     the list contains all values of that algorithm.
     """
     result = {}
-    for hash_value in hases.values():
+    for hash_value in hashes.values():
         try:
             name, hash_value = hash_value.split(":")
         except ValueError:
             name = "sha256"
         result.setdefault(name, []).append(hash_value)
     return result
+
+
+def get_user_email_from_git() -> Tuple[str, str]:
+    """Get username and email from git config.
+    Return empty if not configured or git is not found.
+    """
+    git = shutil.which("git")
+    if not git:
+        return "", ""
+    try:
+        username = subprocess.check_output(
+            [git, "config", "user.name"], text=True
+        ).strip()
+    except subprocess.CalledProcessError:
+        username = ""
+    try:
+        email = subprocess.check_output(
+            [git, "config", "user.email"], text=True
+        ).strip()
+    except subprocess.CalledProcessError:
+        email = ""
+    return username, email

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.pdm]
 name = "pdm"
-version = "0.0.2"
+version = "0.0.3"
 description = "Python Development Master"
 author = "frostming <[email protected]>"
 license = "MIT"

tests/cli/test_actions.py

@@ -24,9 +24,10 @@ def test_sync_only_different(project, repository, synchronizer, capsys):
     )
     do_add(project, packages=["requests"])
     out, _ = capsys.readouterr()
-    assert "3 packages added" in out
+    assert "4 packages added" in out
     assert "1 package updated" in out
     assert "foo" in synchronizer.working_set
+    assert "test-project" in synchronizer.working_set
     assert synchronizer.working_set["chardet"] == "3.0.4"
 
 

tests/conftest.py

@@ -12,6 +12,7 @@
 
 import pytest
 
+from pdm.cli.actions import do_init
 from pdm.context import context
 from pdm.exceptions import CandidateInfoNotFound
 from pdm.installers import Synchronizer
@@ -210,7 +211,7 @@ def project(tmp_path, mocker):
     mocker.patch("pdm.utils.get_finder", get_local_finder)
     mocker.patch("pdm.models.environment.get_finder", get_local_finder)
     mocker.patch("pdm.cli.commands.Project", return_value=p)
-    p.init_pyproject()
+    do_init(p, "test_project", "0.0.0")
     return p