Skip to main content

Smart Environments handling - Define command hooks, file hooks and env variables in python and activate hot reloaded shells.

Project description

Define environmental variables in python and activate hot reloaded shells for them.

Features

  • Initialisation of variables in a given directory (creates common variables file too)

user@pc:/project$ envo local --init  # creates local environment python files
  • Easy and dynamic handling in .py files (See documentation to learn more)

  • Provides addons like handling virtual environments

user@pc:/project$ envo local --init=venv  # will add .venv to PATH
  • Automatic env variables generation based on defined python variables

  • Hot reload. Activated shell will reload environmental variables when files change.

  • Activating shells for a given environment

user@pc:/project$ envo local
🐣(project)user@pc:/project$
🐣(project)user@pc:/project$ exit
user@pc:/project$ envo prod
🔥(project)user@pc:/project$
  • Saving variables to a regular .env file

user@pc:/project$ envo local --save
  • Printing variables (handy for non interactive CLIs like CI or docker)

user@pc:/project$ envo local --dry-run
  • Detects undefined variables.

  • Perfect for switching kubernetes contexts and devops tasks

Example

Initialising environment

user@pc:/project$ envo local --init

Will create env_comm.py and env_local.py

# env_comm.py
@dataclass
class ProjectEnvComm(Env):
    @dataclass
    class Python(BaseEnv):
        version: str

    class Meta:
        raw = ["kubeconfig"]  # disable namespacing

    python: Python
    number: int
    kubeconfig: Path
    # Add more variables here

    def __init__(self) -> None:
        super().__init__(root=Path(os.path.realpath(__file__)).parent)
        self.name = "proj"
        self.python = self.Python(version="3.8.2")
        self.kubeconfig = self.root / f"{self.stage}/kubeconfig.yaml"

# env_local.py
@dataclass
class ProjectEnv(ProjectEnvComm):
    def __init__(self) -> None:
        self.stage = "test"
        self.emoji = "🛠️"
        super().__init__()

        self.number = 12

Env = ProjectEnv

Example usage:

user@pc:/project$ envo  # short for "envo local"
🐣(project)user@pc:/project$ echo $PROJ_PYTHON_VERSION
3.8.2
🐣(project)user@pc:/project$echo $PROJ_NUMBER
12

TODO: Major: * Refactor start_in * Add file hooks * Add bootstrap (versioning etc) * add error line number

Minor: * Shell should highlight envo commands on green * Unnecessary prompt rendered again aftet Ctr-d (only on xonsh?) * work on public/private fields and methods * add examples * print hooks for repr * Add reload command

Bugs: * exiting while env loading yields Attribute Error

Improvements: * type checking ?

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

envo-0.9.9.2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

envo-0.9.9.2-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file envo-0.9.9.2.tar.gz.

File metadata

  • Download URL: envo-0.9.9.2.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.6.13 Linux/4.15.0-1103-aws

File hashes

Hashes for envo-0.9.9.2.tar.gz
Algorithm Hash digest
SHA256 60faefa1b2c1955931a909e390b094846e894206dd82f65cefd13ac0425f5a58
MD5 bbb573e03aa328c692e12aa4a8a9a4cd
BLAKE2b-256 2ab3ce0b25eb5333ec24522c9124a4bc992bd1ef0bc009950f767f2af04f0917

See more details on using hashes here.

File details

Details for the file envo-0.9.9.2-py3-none-any.whl.

File metadata

  • Download URL: envo-0.9.9.2-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.6.13 Linux/4.15.0-1103-aws

File hashes

Hashes for envo-0.9.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6adc75982db2c82ddfdd2f047048ee70c533d54c396484dabc2e6010fcc78c6b
MD5 ee3eb2a7c3700b797aebf53855e95bc4
BLAKE2b-256 b7ca218a55b7cf2fe0cbf4aafc17f498a9ab6aac6e677d5d6a91ac045d6309c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page