When a new developer joins our team, everybody wants to give them the best possible experience 🙌.

We’ve created a simple command line app in Python that with minimum configuration helps the new developer, in a geeky way, set up his/her environment and checks if everything works! It also gives information about which services would they have access to so they can check and don’t need to go somewhere else for that info.

We use Click, the library to create Command line interfaces in Python, and YAML for the configuration. The config has a specific structure moreover, we can configure the file path so someone could reuse the project for their own company 🤓.

The documentation is in the README. You can set the company information in the config, as in our own that you could use as an example. To use your config file, you can set ONBOARDING_FILE_PATH.

You can install it with pipenv.

pip3 install pipenv
pipenv --python 3.7
pipenv install

Once this command finishes, we can run it using pipenv.

export ONBOARDING_FILE_PATH=config.yml
pipenv run python cli.py

It has the configuration to launch from VS Code Debug tab too.

You can see here the output of the app with my company configuration.

The project is open source and can you can clone it from GitHub.

Maybe if we have time, we’ll create a Python package and add more functionality 🎸, but for now, it does the trick. :-)

Cover image by Photo by Harley-Davidson on Unsplash