flex-docker 0.2.2

Flex docker is a utility wrapper around docker and docker-compose commands providing defaults values for projects

Introduction

Local development productivity tools meant to smooth and ease developers day to day work. It is meant to be cross-platform but for now is tested using MacOs and Ubuntu

This are few examples

• unified command line interfaces for multiple cli tools

• interactive command line mode

  • this act as an interactive wrapper on top of existing cli tools
  • also allow extending the existing cli tools with auto-completion, input enhanced wizard or description
  • allow switching between command namespaces in the same terminal

• Implement custom CLI tools using Python, fully integrate with all LCLI tool features:

  • just write some code class or function and configure them to be wired in application

• use Fire to auto document Python objects, so all you should do is to focus on business logic

Features

Fire mode

In fire mode the application allow user to configure a hierarchy of objects that fit its needs for various project. The user can navigate and execute the hierarchy using Fire library by Google. "Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object." https://github.com/google/python-fire

Interactive mode

Most often during the development process developers are using various tools for various projects. The interactive mode purpose is to improve productivity by offering auto-completion details on the spot. This is implemented on top of python cmd package: https://docs.python.org/3/library/cmd.html

Getting Started

Installation process

Install from source

# Using invoke
invoke install
#from project root directory
./install
#or 
python3 -m pip install -r requirements.txt
python3 -m pip install . --user

Software dependencies

This is a Python package available as MIT License and is depending on following packages:

• fire https://github.com/google/python-fire/releases
• pinject https://github.com/google/pinject/releases
• PyYAML
• prompt_toolkit
• pyfiglet
• blessings
• tk
• appJar
• jsonschema

Latest releases

• V-0.2.2 - First released version.

API references

Build and Test

Build

# Using invoke
invoke build

Test

# Using invoke
invoke test
invoke coverage
# Using pytest
py.test
pytest --cov=src/lcli/ .

Use cases

Usage

Configuration

Author

George Babarus

Contribute

Feel free to contribute to this project and make developer life essayer:

• by submitting new ideas as a github issue here
• by making pull request with specific bug fixes
• for new features or architectural change please contact George Babarus to avoid double work on any way.

Useful links

• https://mypy.readthedocs.io/en/latest/generics.html#generics
• https://code-maven.com/interactive-shell-with-cmd-in-python
• https://www.journaldev.com/16140/python-system-command-os-subprocess-call
• https://stackoverflow.com/questions/3262569/validating-a-yaml-document-in-python
• https://github.com/oclif/oclif#-cli-types
• https://medium.com/the-z/getting-started-with-oclif-by-creating-a-todo-cli-app-b3a2649adbcf
• https://opensource.com/article/17/5/4-practical-python-libraries