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.11.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

envo-0.9.9.11-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: envo-0.9.9.11.tar.gz
  • Upload date:
  • Size: 27.0 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.11.tar.gz
Algorithm Hash digest
SHA256 f1f07dc680f822482fe62cdacba69c3c6f77221e4e4ebbeed38b8488dd8c2bc4
MD5 b931f7e90bf1bda868da326d54cad7d3
BLAKE2b-256 31f95b2677639a331aca976eb9fc8ccc584f29de69082b4bf73a9df743a7c90c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: envo-0.9.9.11-py3-none-any.whl
  • Upload date:
  • Size: 30.6 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 9cc441f55e74071b9f415d1989d6fe7765c0fb71a9a9647f42a441284120ceaa
MD5 0a0f296d3894349fa62a466e3dc090d0
BLAKE2b-256 3fdf63167694a90e339d4de03b200a5e09c440c8c20f70e8b6008904d992c875

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