Skip to main content

A cli to provision and manage local developer environments.

Project description

Actions Status Actions Status Quality Gate Status CodeQL Codacy Badge PyPI version PyPI download month Linux macOS

Freshenv

freshenv is a command line application to provision and manage local developer environments.

Why?

This is a solution to a problem I have always had. I like my system to be clean, minimal and structured. It gets quite tricky to manage multiple projects on your on machine, projects tend to gather and are placed everywhere. Overtime managing system wide dependencies becomes a problem. It quite easy to mess up a system setting or to keep track of a package you wont need tomorrow. This is why i built freshenv. It is a command line application which helps developers in running and managing completely isolated developer environments locally. It fetches and lets you run environment flavours in the form of docker containers which are preconfigured with tools and packages developer needs everyday. Read about the usage below. I imagine it would help developers like me, its free and open source. I hope you like it.

Installation

Install the freshenv python package from pypi. You must have docker and python3.6+ installed.

  pip install freshenv

Usage

Usage: freshenv [OPTIONS] COMMAND [ARGS]...

  A cli to provision and manage local developer environments.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  check      Check system compatibility for running freshenv.
  provision  Provision a developer environment.
  remove     Remove a freshenv environment.
  start      Resume working in an environment.
  view       View local freshenv managed environments.

Commands and Options

provision

Usage: freshenv provision [OPTIONS]

  Provision a developer environment.

Options:
  -f, --flavour TEXT   The flavour of the environment.  [default: devenv]
  -c, --command TEXT   The command to execute at startup of environment.[default: zsh]
  -p, --ports INTEGER  List of ports to forward.  [default: 3000]
  -n, --name TEXT      Name of your environment.
  --help               Show this message and exit.

start

Usage: freshenv start [OPTIONS]

  Resume working in an environment.

Options:
  -n, --name TEXT  Name of your environment to resume.  [required]
  --help           Show this message and exit.

remove

Usage: freshenv remove [OPTIONS]

  Remove a freshenv environment.

Options:
  -n, --name TEXT  Name of the environment to remove.  [required]
  -f, --force      Force remove an environment.
  --help           Show this message and exit.

view

Usage: freshenv view [OPTIONS]

  View local freshenv managed environments.

Options:
  --help  Show this message and exit.

check

Usage: freshenv check [OPTIONS]

  Check system compatibility for running freshenv.

Options:
  --help  Show this message and exit.

License

MIT

Contributing

Contributions are always welcome!

See contributing.md for ways to get started. Please adhere to this project's code of conduct.

Contact

Contact me at email raiyanyahyadeveloper@gmail.com.

Project details


Download files

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

Source Distribution

freshenv-0.1.1.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

freshenv-0.1.1-py2.py3-none-any.whl (8.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file freshenv-0.1.1.tar.gz.

File metadata

  • Download URL: freshenv-0.1.1.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for freshenv-0.1.1.tar.gz
Algorithm Hash digest
SHA256 34a52eccb7c890149e74a9f8092210d4c7dd4d2515296d4847c9c5dd8665c04f
MD5 40787ace0198fb92d16fcbf6396d44a0
BLAKE2b-256 20a18338ccf067121bb95a218f54675ab488234c70ae34f0829080dbad89931d

See more details on using hashes here.

File details

Details for the file freshenv-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: freshenv-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for freshenv-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b6ba5aeded8ff0463a5b38943dc872a06289d2682dc6c92a6d4f0e4b6b9717af
MD5 5efa89c1fa7ba7695e410759a20e0c52
BLAKE2b-256 1b4b8bc71ec22ce95f210d9b2d8dad35e4243ddc36be9a1237a67bb271891bd0

See more details on using hashes here.

Supported by

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