EZDocker

A simple app to run Docker containers easily.

• Create a folder on your machine (i.e., docker-apps)
• Create your docker-compose file in these folders

when you want to run those containers just type

ezdocker container_name

FAQs

Wait! Why not just use docker-compose?

Great question, I was doing that for a while, this tool is about centralizing and standardizing the way I invoke containers on my system. I want it to be nearly as easy as running a shell command.

Instead of

cd /path/to/containers/openwebui
docker-compose up -d

I can just type

ezdocker openwebui

Installation

Install via pipx or pip:

poetry build
# Using pipx
pipx install .

# Or using pip
pip install .

Usage

1. Create a config file at ~/.ezdock_config with the following content:

   [global]
   base_directory = ~/docker-apps  # Supports ~, $HOME, $PWD

2. Run a container:

   ezdocker start <container_name>

3. Stop a container:

   ezdocker stop <container_name>

4. Get status of a container

   ezdocker status <container_name>
   openwebui - http://localhost:9000
   flowise - http://localhost:3000

Contribution

Contributions welcome! To get started:

1. Fork the repository and clone your local copy.
2. Install dependencies using Poetry:

   poetry install

3. Make changes to the codebase.
4. Run tests before submitting a pull request:

   pytest

5. Submit a pull request with a clear description of your changes.

Code Style

• Follow PEP8 for Python code formatting.
• Use ruff for formatting and linting:

  ruff check .
  ruff format .

• Ensure all changes are type-checked with mypy:

  mypy ezdocker/

Feature Requests & Issues

• Report issues or suggest features in the GitHub Issues section.
• For major changes, please open an issue first to discuss the direction.

Happy coding! 🚀