sysetup 1.0.26__tar.gz → 1.2.0__tar.gz

{sysetup-1.0.26 → sysetup-1.2.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 quintenroets
+Copyright (c) 2023 Quinten Roets
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

sysetup-1.2.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: sysetup
+Version: 1.2.0
+Summary: Personal system setup
+Author-email: Quinten Roets <qdr2104@columbia.edu>
+License: MIT
+Project-URL: Source Code, https://github.com/quintenroets/sysetup
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: backupmaster<2,>=1.2.6
+Requires-Dist: dbus-next<1,>=0.2.3
+Requires-Dist: package-utils[context]<1,>=0.6.1
+Requires-Dist: powercli<1,>=0.3.1
+Requires-Dist: python-dotenv<2,>=1.0.1
+Requires-Dist: requests<3,>=2.32.3
+Requires-Dist: superpathlib<3,>=2.0.4
+Provides-Extra: dev
+Requires-Dist: package-dev-tools<1,>=0.5.11; extra == "dev"
+Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
+
+# Sysetup
+[![PyPI version](https://badge.fury.io/py/sysetup.svg)](https://badge.fury.io/py/sysetup)
+![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
+![Operating system](https://img.shields.io/badge/os-linux-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-66%25-brightgreen)
+## [Plasma](https://kde.org/plasma-desktop/) 5.22 required
+
+[Setup info](docs/setup-plasma.md)
+
+## Setup steps
+1) Run
+   ```shell
+   wget -O - https://raw.githubusercontent.com/quintenroets/sysetup/main/bin/setup | bash
+   ```
+   give rclone password when prompted
+2) Appearance
+    * Set wallpaper
+    * Select We10OSX Cursors
+3) Configure autocpufreq
+4) Setup Chrome
+    * Enable GPU acceleration in chrome://flags
+    * PDF viewer: set page zoom to page fit
+    * Import certificate from Scripts/assets/sysetup/certificates/certificate.crt
+    * Click experimental: enable tab groups save and sync
+5) Login to
+    * Pycharm professional
+    * VNC Server
+6) For new device: set touchpad scroll direction and click on touch
+
+## Installation
+```shell
+pip install sysetup
+```

sysetup-1.2.0/README.md

@@ -0,0 +1,33 @@
+# Sysetup
+[![PyPI version](https://badge.fury.io/py/sysetup.svg)](https://badge.fury.io/py/sysetup)
+![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
+![Operating system](https://img.shields.io/badge/os-linux-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-66%25-brightgreen)
+## [Plasma](https://kde.org/plasma-desktop/) 5.22 required
+
+[Setup info](docs/setup-plasma.md)
+
+## Setup steps
+1) Run
+   ```shell
+   wget -O - https://raw.githubusercontent.com/quintenroets/sysetup/main/bin/setup | bash
+   ```
+   give rclone password when prompted
+2) Appearance
+    * Set wallpaper
+    * Select We10OSX Cursors
+3) Configure autocpufreq
+4) Setup Chrome
+    * Enable GPU acceleration in chrome://flags
+    * PDF viewer: set page zoom to page fit
+    * Import certificate from Scripts/assets/sysetup/certificates/certificate.crt
+    * Click experimental: enable tab groups save and sync
+5) Login to
+    * Pycharm professional
+    * VNC Server
+6) For new device: set touchpad scroll direction and click on touch
+
+## Installation
+```shell
+pip install sysetup
+```

sysetup-1.2.0/pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "sysetup"
+version = "1.2.0"
+description = "Personal system setup"
+authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "backupmaster >=1.2.6, <2",
+    "dbus-next >=0.2.3, <1",
+    "package-utils[context] >=0.6.1, <1",
+    "powercli >=0.3.1, <1",
+    "python-dotenv >=1.0.1, <2",
+    "requests >=2.32.3, <3",
+    "superpathlib >=2.0.4, <3",
+]
+
+[project.optional-dependencies]
+dev = [
+    "package-dev-tools >=0.5.11, <1",
+    "package-dev-utils >=0.1.6, <1",
+]
+
+[project.urls]
+"Source Code" = "https://github.com/quintenroets/sysetup"
+
+[project.scripts]
+sysetup = "sysetup.cli:entry_point"
+exportcrontab = "sysetup.main.files.assets:move_crontab"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.coverage.run]
+command_line = "-m pytest tests"
+
+[tool.coverage.report]
+precision = 4
+fail_under = 60
+
+[tool.mypy]
+strict = true
+no_implicit_reexport = false
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src", ".",
+]
+
+[tool.ruff]
+fix = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "ANN101",  # annotate self
+    "ANN102",  # annotate cls
+    "ANN401",  # annotated with Any
+    "D", # docstrings
+    "S101", # assert used
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["src"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.setuptools]
+script-files = ["bin/pw", "bin/pw-askpass"]
+
+[tool.setuptools.package-data]
+sysetup = ["assets/scripts/update_wallpaper.js", "py.typed"]

sysetup-1.2.0/src/sysetup/cli/__init__.py

@@ -0,0 +1 @@
+from .entry_point import entry_point

sysetup-1.2.0/src/sysetup/cli/entry_point.py

@@ -0,0 +1,6 @@
+from package_utils.context.entry_point import create_entry_point
+
+from sysetup.context import context
+from sysetup.main.main import main
+
+entry_point = create_entry_point(main, context)

sysetup-1.2.0/src/sysetup/context/__init__.py

@@ -0,0 +1 @@
+from .context import Context, context

sysetup-1.2.0/src/sysetup/context/context.py

@@ -0,0 +1,31 @@
+import os
+from collections.abc import Iterator
+from functools import cached_property
+
+import cli
+from package_utils.context import Context as Context_
+
+from sysetup.models import Options
+
+
+class Context(Context_[Options, None, None]):
+    @cached_property
+    def package_manager(self) -> str:
+        def generate_package_manager() -> Iterator[str]:
+            package_managers = "apt-get", "pacman"
+            for package_manager in package_managers:
+                if cli.completes_successfully("which", package_manager):
+                    yield package_manager
+
+        return next(generate_package_manager())
+
+    @cached_property
+    def apt_is_installed(self) -> bool:
+        return self.package_manager == "apt-get"
+
+    @cached_property
+    def is_running_in_test(self) -> bool:
+        return "DISPLAY" not in os.environ
+
+
+context = Context(Options)

sysetup-1.2.0/src/sysetup/main/environment.py

@@ -0,0 +1,14 @@
+import os
+
+from dotenv import load_dotenv
+
+from sysetup.models import Path
+from sysetup.utils import download_file
+
+
+def setup() -> None:
+    download_file(Path("etc") / "environment")
+    if "SUDO_ASKPASS" not in os.environ:
+        path = Path.HOME / ".bask_profile"
+        download_file(Path.HOME / ".bask_profile")
+        load_dotenv(dotenv_path=Path.HOME / path)

sysetup-1.2.0/src/sysetup/main/files/__init__.py

@@ -0,0 +1 @@
+from .setup import setup

sysetup-1.2.0/src/sysetup/main/files/assets.py

@@ -0,0 +1,40 @@
+import cli
+from backup.backups.cache import cache
+
+from sysetup.models import Path
+from sysetup.utils import download_directory
+
+
+def setup() -> None:
+    download_directory(Path.assets)
+    move_crontab()
+    move_setup_files()
+
+
+def move_crontab() -> None:
+    src = Path.assets / "crontab" / "crontab"
+    cli.run("crontab -", input=src.text)
+
+
+def move_setup_files() -> None:
+    setup_files_root = Path.assets / "files"
+    setup_files = []
+    archived_setup_files = []
+    for path in setup_files_root.rglob("*"):
+        if path.is_file():
+            if path.archive_format is None:
+                setup_files.append(path)
+            else:
+                archived_setup_files.append(path)
+
+    backup = cache.Backup(paths=setup_files)
+    backup.pull()
+
+    for path in archived_setup_files:
+        dest = (backup.source / path.relative_to(setup_files_root)).parent
+        if dest.is_root and not dest.exists():
+            cli.run("mkdir -p", dest, root=True)
+        else:
+            dest.create_parent()
+        with cli.status(f"Unpacking {path.relative_to(setup_files_root)}"):
+            cli.capture_output("unzip -o", path, "-d", dest, root=dest.is_root)

sysetup-1.2.0/src/sysetup/main/files/permissions.py

@@ -0,0 +1,33 @@
+import stat
+
+import cli
+
+from sysetup.models import Path
+from sysetup.utils import download_directory
+
+
+def setup() -> None:
+    set_git_permissions()
+    set_ssh_permissions()
+
+
+def set_git_permissions() -> None:
+    git_hooks_folder = Path.HOME / ".config" / "git" / "hooks"
+    download_directory(git_hooks_folder)
+    for path in git_hooks_folder.iterdir():
+        cli.run("chmod +x", path)
+
+
+def set_ssh_permissions() -> None:
+    directory = Path.HOME / ".ssh"
+    download_directory(directory)
+    for path in directory.glob("id_*"):
+        if path.suffix != ".pub":
+            check_permissions(path)
+
+
+def check_permissions(path: Path) -> None:
+    permissions = path.stat().st_mode
+    other_users_can_read = permissions & (stat.S_IRGRP | stat.S_IROTH)
+    if other_users_can_read:
+        path.chmod(33152)

sysetup-1.2.0/src/sysetup/main/files/settings.py

@@ -0,0 +1,45 @@
+import cli
+
+from sysetup.context import context
+from sysetup.models import Path
+from sysetup.utils import download_directory
+
+
+def remove_clutter() -> None:
+    names = (
+        "Desktop",
+        "Downloads",
+        "Music",
+        "Pictures",
+        "Public",
+        "Templates",
+        "Videos",
+    )
+    for name in names:
+        path = Path.HOME / name
+        path.rmtree(missing_ok=True)
+
+    nginx_path = Path("/") / "etc" / "nginx" / "sites-enabled" / "default"
+    if nginx_path.exists():
+        cli.run("rm", nginx_path, root=True)
+
+
+def set_background() -> None:  # pragma: nocover
+    wallpaper_path = (
+        Path.HOME / ".local" / "share" / "wallpapers" / "Qwallpapers" / "background.jpg"
+    )
+    download_directory(wallpaper_path.parent)
+    wallpaper_uri = wallpaper_path.as_uri()
+    script = Path.update_wallpaper_script.text.replace(
+        "__wallpaper_uri__",
+        wallpaper_uri,
+    )
+    run_kde_script(script)
+
+
+def run_kde_script(script: str) -> None:  # pragma: nocover
+    command = (
+        "qdbus org.kde.plasmashell /PlasmaShell org.kde.PlasmaShell.evaluateScript"
+    )
+    if not context.is_running_in_test:
+        cli.run(command, script)

sysetup-1.2.0/src/sysetup/main/files/setup.py

@@ -0,0 +1,8 @@
+from sysetup.main.files import assets, permissions, settings
+
+
+def setup() -> None:
+    permissions.setup()
+    assets.setup()
+    settings.set_background()
+    settings.remove_clutter()

sysetup-1.2.0/src/sysetup/main/installations.py

@@ -0,0 +1,67 @@
+import os
+
+import cli
+
+from sysetup.context import context
+from sysetup.models import Path
+
+
+def setup() -> None:
+    install_chromium()
+    install_jumpapp()
+    install_language_support()
+    install_linter_env()
+    install_personal_git_repositories()
+
+
+def install_personal_git_repositories() -> None:
+    base_url = "https://github.com/quintenroets"
+    token = os.getenv("GITHUB", None)
+    if token is not None:
+        base_url = base_url.replace("github.com", f"{token}@github.com")
+    if not Path.extensions.exists():
+        command = f"git clone {base_url}/extensions.git"
+        cli.run(command, Path.extensions)
+    cli.run(f"pip install git+{base_url}/system.git")
+
+
+def install_language_support() -> None:
+    try:
+        packages = cli.capture_output("check-language-support")
+    except FileNotFoundError:
+        pass
+    else:
+        if packages:
+            cli.install(packages)
+
+
+def install_chromium() -> None:
+    if not cli.capture_output("which chromium-browser", check=False):
+        _install_chromium()
+
+
+def _install_chromium() -> None:
+    release_name = cli.capture_output_lines("lsb_release -sc")[-1]
+    repo_url = f"https://freeshell.de/phd/chromium/{release_name}"
+    commands = (
+        f'echo "deb {repo_url} /" | sudo tee /etc/apt/sources.list.d/phd-chromium.list',
+        "apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 869689FE09306074",
+        "apt-get update",
+        "apt-get install -y chromium",
+    )
+    check = not context.is_running_in_test
+    cli.run_commands(*commands, shell=True, root=True, check=check)  # noqa: S604
+
+
+def install_linter_env() -> None:
+    if not Path.linter_env.exists():
+        cli.run("python -m venv", Path.linter_env.name, cwd=Path.linter_env.parent)
+        python_path = Path.linter_env / "bin" / "python"
+        cli.run(f"{python_path} -m pip install autoimport powertrace-hooks")
+
+
+def install_jumpapp() -> None:
+    if not cli.capture_output("which jumpapp", check=False):
+        with Path.tempdir() as directory:
+            cli.run("git clone https://github.com/mkropat/jumpapp", directory)
+            cli.run_commands("make", "sudo make install", cwd=directory)

sysetup-1.2.0/src/sysetup/main/main.py

@@ -0,0 +1,30 @@
+import cli
+
+from sysetup.context import context
+from sysetup.models import Action
+
+from . import environment, files, installations, packages
+
+
+def main() -> None:
+    """
+    Personal system setup.
+    """
+    action_mapper = {
+        Action.all.value: setup,
+        Action.env.value: environment.setup,
+        Action.files.value: files.setup,
+        Action.install.value: installations.setup,
+        Action.packages.value: packages.setup,
+    }
+    action = action_mapper[context.options.action.value]
+    action()
+
+
+def setup() -> None:
+    environment.setup()
+    packages.setup()
+    files.setup()
+    installations.setup()
+    if not context.is_running_in_test:
+        cli.run("reboot now", root=True)

sysetup-1.2.0/src/sysetup/main/packages.py

@@ -0,0 +1,60 @@
+import cli
+
+from sysetup.context import context
+from sysetup.models import Path
+from sysetup.utils import download_directory
+
+
+def setup() -> None:
+    update_package_manager()
+    install_packages()
+    cleanup_after_install()
+
+
+def install_packages() -> None:
+    download_directory(Path.packages)
+    installations = {"packages": None, "snap": "snap install"}
+    for name, command in installations.items():
+        path = (Path.packages / name).with_suffix(".yaml")
+        packages: list[str] = path.yaml
+        cli.install(*packages, install_command=command)
+
+
+def update_package_manager() -> None:
+    if context.apt_is_installed:
+        update_apt()
+    else:
+        cli.run("pacman -Syy", root=True)
+
+
+def update_apt() -> None:
+    agree_eula_command = (
+        "echo ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula"
+        "select true | sudo debconf-set-selections"
+    )
+    commands = ["sudo apt-get update", agree_eula_command]
+    if not context.is_running_in_test:
+        # snap currently doesn't work on arm
+        commands.append("sudo systemctl enable --now snapd.socket")
+    cli.run_commands_in_shell(*commands)
+    if not Path("/snap").exists():
+        cli.run("ln -s /var/lib/snapd/snap /snap", root=True)
+
+
+def cleanup_after_install() -> None:
+    after_install_command = (
+        "sudo apt-get autoremove -y"
+        if context.apt_is_installed
+        else (
+            "sudo pacman -S --noconfirm python-pip; sudo pacman -S --noconfirm"
+            " base-devel; pip install wheel"
+        )
+    )
+    cli.run_commands_in_shell(after_install_command, "sudo tlp start")
+    cli.run("systemctl enable ssh", root=True)  # start ssh server before log in
+    delete = "apt purge -y" if context.apt_is_installed else "pacman -R --noconfirm"
+    commands = (
+        "auto-cpufreq --install",  # Fails on VM
+        f"{delete} firefox",  # fails if firefox not installed
+    )
+    cli.run_commands(*commands, check=False, root=True)

sysetup-1.2.0/src/sysetup/models/__init__.py

@@ -0,0 +1,3 @@
+from .action import Action
+from .options import Options
+from .path import Path

sysetup-1.2.0/src/sysetup/models/action.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class Action(str, Enum):
+    all = "all"
+    files = "files"
+    packages = "packages"
+    install = "install"
+    env = "env"

sysetup-1.2.0/src/sysetup/models/options.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+from typing import Annotated
+
+import typer
+
+from .action import Action
+
+
+@dataclass
+class Options:
+    action: Annotated[Action, typer.Argument(help="The part to setup")] = Action.all

{sysetup-1.0.26/sysetup → sysetup-1.2.0/src/sysetup/models}/path.py

@@ -1,5 +1,4 @@
-import typing
-from typing import TypeVar
+from typing import TypeVar, cast
 
 import superpathlib
 from simple_classproperty import classproperty
@@ -11,40 +10,40 @@ class Path(superpathlib.Path):
     @classmethod
     @classproperty
     def source_root(cls: type[T]) -> T:
-        return cls(__file__).parent
+        return cls(__file__).parent.parent
 
     @classmethod
     @classproperty
     def assets(cls: type[T]) -> T:
         path = cls.script_assets / cls.source_root.name
-        return typing.cast(T, path)
+        return cast(T, path)
 
     @classmethod
     @classproperty
     def config(cls: type[T]) -> T:
         path = cls.assets / "config" / "config.yaml"
-        return typing.cast(T, path)
+        return cast(T, path)
 
     @classmethod
     @classproperty
     def packages(cls: type[T]) -> T:
         path = cls.assets / "packages"
-        return typing.cast(T, path)
+        return cast(T, path)
 
     @classmethod
     @classproperty
     def linter_env(cls: type[T]) -> T:
-        path = cls.assets / "linterenv"
-        return typing.cast(T, path)
+        path = Path.HOME / ".local" / "share" / "envs" / "linterenv"
+        return cast(T, path)
 
     @classmethod
     @classproperty
     def extensions(cls: type[T]) -> T:
         path = cls.HOME / ".local" / "share" / "extensions"
-        return typing.cast(T, path)
+        return cast(T, path)
 
     @classmethod
     @classproperty
     def update_wallpaper_script(cls: type[T]) -> T:
         path = cls.source_root / "assets" / "scripts" / "update_wallpaper.js"
-        return typing.cast(T, path)
+        return cast(T, path)

sysetup-1.2.0/src/sysetup/utils/__init__.py

@@ -0,0 +1 @@
+from .download import download_directory, download_file

sysetup-1.2.0/src/sysetup/utils/download.py

@@ -0,0 +1,12 @@
+from backup.backups import Backup
+from backup.models import Path as BackupPath
+
+from sysetup.models import Path
+
+
+def download_directory(path: Path) -> None:
+    Backup(sub_check_path=BackupPath(path), confirm=False).pull()
+
+
+def download_file(path: Path) -> None:
+    Backup(path=BackupPath(path), confirm=False).pull()