"""Checks related to the .env file in the repository.""" import subprocess from pathlib import Path # List of all the environment variables that are desired DESIRED_ENVIRONMENT_VARIABLES = dict( GPG_KEY_ID="Enter GPG key ID or leave empty if you do not want to use it. Type " "`gpg --list-secret-keys --keyid-format=long | grep sec | sed -E " "'s/.*\/([^ ]+).*/\\1/'` to see your key ID:\n> ", # noqa GIT_NAME="Enter your full name, to be shown in Git commits:\n> ", GIT_EMAIL="Enter your email, as registered on your Github account:\n> ", PYPI_API_TOKEN="Enter your PyPI API token, or leave empty if you do not want " "to use it:\n> ", ) def fix_dot_env_file(): """Ensures that the .env file exists and contains all desired variables.""" # Create path to the .env file env_file_path = Path(".env") # Ensure that the .env file exists env_file_path.touch(exist_ok=True) # Otherwise, extract all the lines in the .env file env_file_lines = env_file_path.read_text().splitlines(keepends=False) # Extract all the environment variables in the .env file env_vars = [line.split("=")[0] for line in env_file_lines] # For each of the desired environment variables, check if it exists in the .env # file env_vars_missing = [ env_var for env_var in DESIRED_ENVIRONMENT_VARIABLES.keys() if env_var not in env_vars ] # Create all the missing environment variables with env_file_path.open("a") as f: for env_var in env_vars_missing: value = "" if env_var == "GPG_KEY_ID": gpg = subprocess.Popen( ["gpg", "--list-secret-keys", "--keyid-format=long"], stdout=subprocess.PIPE, ) grep = subprocess.Popen( ["grep", "sec"], stdin=gpg.stdout, stdout=subprocess.PIPE ) value = ( subprocess.check_output( ["sed", "-E", "s/.*\\/([^ ]+).*/\\1/"], stdin=grep.stdout, ) .decode() .strip("\n") ) gpg.wait() grep.wait() if value == "": value = input(DESIRED_ENVIRONMENT_VARIABLES[env_var]) f.write(f'{env_var}="{value}"\n') if __name__ == "__main__": fix_dot_env_file()