Giter Club home page Giter Club logo

docker-helper's Introduction

Docker-Helper

Project Details

๐ŸŽฏ This project's goal is helping people while using Docker and making to use Docker easier.

โฒ๏ธ Future plans about project is located in this Figma chart.

Installation

Make sure Python and pip is installed by using this commands in your command line

python --version
pip --version

If they are installed use this to install the requirements:

pip install -r requirements.txt

For run the script:

python main.py

docker-helper's People

Contributors

blackseadeveloper avatar sevilayerkan avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

docker-helper's Issues

feat: check docker is installed or not

Pseudocode of this function:

check_install() bool *
{
 if(docker is installed){
  return 1
 } else{
  return 0
 }
}

OS difference should be taken into account.

feat(core) : isRunning function needs to be added

Is your feature request related to a problem? Please describe.
isRunning function needs to be added for checking docker daemon is running or not.

Describe the solution you'd like
for resolve this issue we can add a function like this:

def isRunning():
   if docker is running:
       return 1
  else:
      return 0

Additional context
This function will be used in show() and in the beginning of the program.

epic: Code must be refactored

Before finishing phase 1 code needs to be refactored.

This refactor job includes:

  • Issue #8 : All user messages and comment lines must be translated into English.
  • Issue #9 : All errors and todo in the code need to be transfer into Github and remove from the codebase
  • Project file structure will change
  • Functions will be in seperate file

feat(core): install and isInstalled functions

install() function and isInstalled() function needs to be implemented since they are working together they would be written at the same time

isInstalled()  //This function will also work before app gets started

install(){
    if(isInstalled())
        return
    else
        install docker

feat: implement tests

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Implement unit tests: Write unit tests to verify the functionality of your DockerHelper class or individual functions. This will help ensure that the code behaves as expected and can catch any regressions or issues when making changes or additions in the future.

feat/bug(core): Add error handling to most core functions

Is your feature request related to a problem? Please describe.
feat/bug(core): Error handling must be implemented to most of the core functions

Add exception handling to handle potential errors that may occur during Docker commands execution. For example, you can catch and display specific error messages when the Docker daemon is not running or when a command fails to execute.

To resolve this issue:

  • We need to decide which functions need error handling
  • Research about how we can implement error handling.

docs: Documentation for final state of project

Documentation of the overall course of the implementation and re-determination of needs according to changing requirements

Because docker compose file generator,
Flask app, etc are coming in needs and documentation should be change.

feat: Clean command

Clean command that deletes unused docker images could be useful. A common issue with using docker is the /var/lib/docker/ folder may take up gigabytes of space which will eventually cause an out of disk space issue on the host system.

Sometimes there are leftover docker images of previously ran docker containers that have not been cleaned up. These images can be removed by running the command below, which will remove all data of non-running containers. source

docker system prune -a --volumes

Removing unused and dangling images will help us to reclaim disk space. We can achieve this using the image prune child command. We can use the system prune child command to remove multiple unused objects in one go. This command removes all unused networks, images, containers (if closed), dangling build caches, and optionally, volumes.

docker image prune -a -f

feat(core): OOP

Is your feature request related to a problem? Please describe.
Implement OOP principles into the core functions

feat(core): User input validation

Is your feature request related to a problem? Please describe.

Validate user inputs: Implement input validation to ensure that user inputs are in the expected format or range. You can add checks to validate container and image names or IDs entered by the user. If an invalid input is provided, display an error message and prompt the user again.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.