docker cli with python
Project description
idocker
Introduce
This tool is a supplement to docker's official command line tool and can output container information in a human-friendly way to increase readability
⭐️ 🌟 ✨ ⚡️ ☄️ 💥
Installation
Package is uploaded on PyPI: idocker
You can install it with pip:
pip install idocker
Requirements
- Python : 3.8 and newer
- Make sure you have docker installed on your machine
Documentation
📄 Intensified preparation in progress
Example
View container running information
Enter the command in the terminal: idocker ps
The following output is obtained
There is a total of 17 container
| id | status | name | memory | cpu (%) |
|:-------------|:-----------|:---------------------|:----------|----------:|
| f96ba3157d97 | ⭕️ exited | mystifying_kapitsa | 0.0 MB | 0 |
| 1647f82f4f5d | ⭕️ exited | hardcore_benz | 0.0 MB | 0 |
| d34a102050d3 | ⭕️ exited | minikube | 0.0 MB | 0 |
| 62e74fb7138e | ⭕️ exited | nginx | 0.0 MB | 0 |
| 21b45572fd50 | ⭕️ exited | thirsty_stonebraker | 0.0 MB | 0 |
| 3a7729ee272b | ⭕️ exited | sad_lalande | 0.0 MB | 0 |
| 16e49729de2d | ⭕️ exited | twitter_redis | 0.0 MB | 0 |
| 98df9168bbd5 | ⭕️ exited | rustdesk-hbbr | 0.0 MB | 0 |
| bf19958f710f | ⭕️ exited | rustdesk-hbbs | 0.0 MB | 0 |
| 874838b6335d | ⭕️ exited | twitter_mysql8 | 0.0 MB | 0 |
| 57469356f55b | ⭕️ exited | heuristic_northcutt | 0.0 MB | 0 |
| 6fd8b4c901f1 | ⭕️ exited | competent_ritchie | 0.0 MB | 0 |
| cb0ef103c8f6 | ✅ running | twitter_memcahed | 5.57 MB | 0.007 |
| aa291a307aac | ✅ running | rebloom | 8.65 MB | 0.098 |
| 1e08693fdcfd | ✅ running | public_minio | 108.28 MB | 0.055 |
| 7b411cf33283 | ✅ running | rabbitmq3-management | 144.1 MB | 0.556 |
| c50ca07d3d41 | ✅ running | mysql8 | 282.34 MB | 0.339 |
By default, the sorting is in ascending order of memory usage
If you want to change the default sorting, you can see the help information 'idocker ps --help'
Usage: python -m idocker.cli.main ps [OPTIONS]
view all container
Options:
--id Sort by id
--status Sort by id
--name Sort by name
--cpu Sort by cpu stats usage
--mem Sort by memory stats usage [default: True]
-i, --image_name Show Image name
--help Show this message and exit.
For example, if you want to know which containers are using the most cpu, you can type 'idocker ps --cpu' and it will be sorted in ascending order of cpu usage
There is a total of 17 container
| id | status | name | memory | cpu (%) |
|:-------------|:-----------|:---------------------|:----------|----------:|
| f96ba3157d97 | ⭕️ exited | mystifying_kapitsa | 0.0 MB | 0 |
| d34a102050d3 | ⭕️ exited | minikube | 0.0 MB | 0 |
| 62e74fb7138e | ⭕️ exited | nginx | 0.0 MB | 0 |
| 57469356f55b | ⭕️ exited | heuristic_northcutt | 0.0 MB | 0 |
| 16e49729de2d | ⭕️ exited | twitter_redis | 0.0 MB | 0 |
| 21b45572fd50 | ⭕️ exited | thirsty_stonebraker | 0.0 MB | 0 |
| 1647f82f4f5d | ⭕️ exited | hardcore_benz | 0.0 MB | 0 |
| 3a7729ee272b | ⭕️ exited | sad_lalande | 0.0 MB | 0 |
| bf19958f710f | ⭕️ exited | rustdesk-hbbs | 0.0 MB | 0 |
| 6fd8b4c901f1 | ⭕️ exited | competent_ritchie | 0.0 MB | 0 |
| 874838b6335d | ⭕️ exited | twitter_mysql8 | 0.0 MB | 0 |
| 98df9168bbd5 | ⭕️ exited | rustdesk-hbbr | 0.0 MB | 0 |
| cb0ef103c8f6 | ✅ running | twitter_memcahed | 5.57 MB | 0.007 |
| 1e08693fdcfd | ✅ running | public_minio | 107.95 MB | 0.054 |
| aa291a307aac | ✅ running | rebloom | 8.63 MB | 0.098 |
| c50ca07d3d41 | ✅ running | mysql8 | 281.5 MB | 0.338 |
| 7b411cf33283 | ✅ running | rabbitmq3-management | 143.62 MB | 0.553 |
Note that cpu 100% does not mean that 100% of the whole machine is consumed, but 100% of the single core
Sometimes, we seem to know the image name of the container, we can add '-i' or '--image name' parameter to display the image name at the same time
╰─➤ idocker ps -i
There is a total of 21 container
| id | status | name | memory | cpu (%) | image |
|:-------------|:-----------|:---------------------|:----------|----------:|:-----------------------------------------|
| 16e49729de2d | ⭕️ exited | twitter_redis | 0.0 MB | 0 | redis:latest |
| 62e74fb7138e | ⭕️ exited | nginx | 0.0 MB | 0 | nginx:latest |
| 3a7729ee272b | ⭕️ exited | sad_lalande | 0.0 MB | 0 | 192.168.31.245:8081/python:3.10-buster |
| 98df9168bbd5 | ⭕️ exited | rustdesk-hbbr | 0.0 MB | 0 | rustdesk/rustdesk-server:1.1.6 |
| d34a102050d3 | ⭕️ exited | minikube | 0.0 MB | 0 | kicbase/stable:v0.0.36 |
| 1647f82f4f5d | ⭕️ exited | hardcore_benz | 0.0 MB | 0 | ubuntu:latest |
| 6fd8b4c901f1 | ⭕️ exited | competent_ritchie | 0.0 MB | 0 | ubuntu:latest |
| 874838b6335d | ⭕️ exited | twitter_mysql8 | 0.0 MB | 0 | mysql:8.0 |
| f96ba3157d97 | ⭕️ exited | mystifying_kapitsa | 0.0 MB | 0 | sha256:b7fb33a5a7bb |
| 57469356f55b | ⭕️ exited | heuristic_northcutt | 0.0 MB | 0 | 192.168.31.245:8081/python:3.10-buster |
| 21b45572fd50 | ⭕️ exited | thirsty_stonebraker | 0.0 MB | 0 | sha256:b7fb33a5a7bb |
| bf19958f710f | ⭕️ exited | rustdesk-hbbs | 0.0 MB | 0 | rustdesk/rustdesk-server:1.1.6 |
| cb0ef103c8f6 | ✅ running | twitter_memcahed | 2.09 MB | 0.008 | memcached:latest |
| aa291a307aac | ✅ running | rebloom | 5.74 MB | 0.104 | redislabs/rebloom:latest |
| 84ef73971e0d | ✅ running | zilliz_attu | 75.91 MB | 0.022 | zilliz/attu:v2.2.7 |
| 75f08019e787 | ✅ running | milvus-etcd | 77.74 MB | 0.688 | quay.io/coreos/etcd:v3.5.5 |
| 98c1082f8e5b | ✅ running | milvus-minio | 87.07 MB | 0.098 | minio/minio:RELEASE.2022-03-17T06-34-49Z |
| 78e26a299331 | ✅ running | public_minio | 133.05 MB | 0.11 | minio/minio:RELEASE.2023-09-04T19-57-37Z |
| 7b411cf33283 | ✅ running | rabbitmq3-management | 156.2 MB | 0.477 | rabbitmq:3-management |
| e2618c7ec2ec | ✅ running | milvus-standalone | 317.84 MB | 4.369 | milvusdb/milvus:v2.2.9 |
| c50ca07d3d41 | ✅ running | mysql8 | 739.54 MB | 1.026 | mysql:8 |
View container port information
Enter the command in the terminal: idocker port
The following output is obtained
There is a total of 3 container
elk-kibana-7
Host -> Container
5601 -> 5601
5601 -> 5601
elk-elasticsearch-7
Host -> Container
9200 -> 9200
9200 -> 9200
9300 -> 9300
9300 -> 9300
rebloom
Host -> Container
6379 -> 6379
6379 -> 6379
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file idocker-1.4.0.tar.gz
.
File metadata
- Download URL: idocker-1.4.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7b9ffc4aa0c04b2e307f2d9fcddacc8b9b57e2672ce87b1b2e55d81ab9aae35 |
|
MD5 | 5c86844cb45c32046f816f3dfbda3653 |
|
BLAKE2b-256 | ba721350fab59b9373b461ad11d440ad32f0694ee8468b1aec1bb2e6eb545204 |
File details
Details for the file idocker-1.4.0-py3-none-any.whl
.
File metadata
- Download URL: idocker-1.4.0-py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e35529e0213d37e9e9d4fc7d8f5be4ef1541197f7a69da6f996dd6cce1d7527b |
|
MD5 | d5577a8b3b1a85c11ab249cba8998efc |
|
BLAKE2b-256 | 9a89496e3f7619e8a38db984d09d673630212f3b0ee4e7e351224ae02aae9b0f |