vtc 0.1.14

A SMPTE timeoce library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

import venv
import sys
import pathlib
import platform

from configparser import ConfigParser

CONFIG_PATH = pathlib.Path(__file__).parent.parent.parent / "setup.cfg"
PLATFORM = platform.system()


def load_cfg() -> ConfigParser:
    """
    loads library config file
    :return: loaded `ConfigParser` object
    """
    config = ConfigParser()
    config.read(CONFIG_PATH)
    return config


def create_venv(lib_name: str, py_version: str) -> pathlib.Path:
    """
    creates the new virtual environment
    :param lib_name: name of library
    :param py_version: string representation of two-digit python version (ie 37)
    :return: path to venv
    """

    venv_name = f"{lib_name}-py-{py_version}-py"
    venv_path = pathlib.Path(f"~/venvs/{venv_name}").expanduser()

    try:
        venv_path.mkdir(parents=True, exist_ok=False)
    except FileExistsError as error:
        raise error

    venv.create(env_dir=str(venv_path), with_pip=True, system_site_packages=True)

    return venv_path


def register_venv(activate_path: pathlib.Path, lib_name: str, py_version: str) -> str:
    """
    registers the new environment with a .bashrc entry alias for easy venv entry
    :param activate_path: path to virtual env activation script
    :param py_version: string representation of two-digit python version (ie 37)
    :param lib_name: name of library
    :return: bash alias to enter venv
    """

    lib_path: pathlib.Path = pathlib.Path(__file__).parent.parent.parent.absolute()

    bash_alias = f"env_{lib_name}-{py_version}"
    command = f'alias {bash_alias}=\'cd "{lib_path}";source "{activate_path}"\''

    if PLATFORM == "Darwin":
        bash_rc_path = pathlib.Path("~/.bash_aliases").expanduser()
    elif PLATFORM == "Linux":
        bash_rc_path = pathlib.Path("~/.bash_aliases").expanduser()
    else:
        raise RuntimeError("operating system not supported for venv creation")

    if bash_rc_path.exists():
        bash_rc_text = bash_rc_path.read_text()
    else:
        bash_rc_text = ""

    if command in bash_rc_text:
        return bash_alias

    bash_rc_text += (
        f"\n"
        f"\n# {lib_name} development virtual env entry for Python {py_version}"
        f"\n{command}"
    )

    with bash_rc_path.open(mode="w") as f:
        f.write(bash_rc_text)

    return bash_alias


def main() -> None:
    """makes virtual environment for development and adds alias to ~/.bashrc"""

    py_version = f"{sys.version_info[0]}{sys.version_info[1]}"

    config = load_cfg()
    lib_name = config.get("metadata", "name")

    venv_path = create_venv(lib_name, py_version)
    activate_path = venv_path / "bin" / "activate"

    bash_alias = register_venv(activate_path, lib_name, py_version)

    sys.stdout.write(str(bash_alias))


if __name__ == "__main__":
    """creates virtual environment and writes path to stdout"""
    main()