Use pipenv, add Dockerfile, add CLI and make graph look nicer

.dockerignore

@@ -0,0 +1,3 @@
+.*
+test/
+example.png

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-patch"]
+      - dependency-name: "*"
+        update-types: ["version-update:semver-minor"]

.github/workflows/docker.yml

@@ -0,0 +1,60 @@
+name: Publish Docker image
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - 'v*'
+jobs:
+  push_to_registry:
+    name: Build and push docker image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Docker meta
+        id: docker_meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ secrets.DOCKERHUB_USERNAME }}/docker-network-graph,ghcr.io/${{ github.repository_owner }}/docker-network-graph
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Cache Docker layers
+        if: github.event_name != 'pull_request'
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to DockerHub
+        uses: docker/login-action@v1 
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1 
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/386,linux/arm/v6,linux/arm/v7,linux/arm64
+          push: True
+          tags: ${{ steps.docker_meta.outputs.tags }}
+          labels: ${{ steps.docker_meta.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache

.gitignore

@@ -1,3 +1,5 @@
-/sandbox
-/*.gv
-/*.pdf
+*.gv
+*.pdf
+*.png
+*.svg
+.idea

Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3-alpine
+
+WORKDIR /usr/src/app
+
+COPY Pipfile Pipfile.lock ./
+
+RUN pip install pipenv
+RUN pipenv install --system --deploy
+
+COPY docker-net-graph.py ./
+
+ENTRYPOINT ["python", "docker-net-graph.py"]

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+docker = "~=3.7"
+graphviz = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"

README.md

@@ -1,12 +1,55 @@
-Docker Network Graph
---------------------
+# Docker Network Graph
 
-Sample python script to draw graph of Docker networks and containers
+Visualize the relationship between Docker networks and containers
+as a neat graphviz graph.
 
 
-Install/run
-===========
+## Example
+![example graph](https://raw.githubusercontent.com/LeoVerto/docker-network-graph/master/example.png)
 
-    #> git clone --recursive https://github.com/eagafonov/docker-network-graph-poc.git
-    #> make install-requirements
-    #> make build-graph
+## Usage
+    usage: docker-net-graph.py [-h] [-v] [-o OUT]
+
+    Visualize docker networks.
+
+    optional arguments:
+      -h, --help         show this help message and exit
+      -v, --verbose      Verbose output
+      -o OUT, --out OUT  Write output to file
+
+In most cases what you want to run are the following couple commands:
+
+    git clone https://github.com/LeoVerto/docker-network-graph.git
+    cd docker-network-graph
+    pipenv install
+    pipenv run python docker-net-graph.py -o output.svg
+
+This will generate an .svg file containing the graph.
+
+## Running inside docker
+If you want to generate a graph for a remote system you can also easily
+run this script inside a pre-built docker container:
+
+    docker run --rm -v /var/run/docker.sock:/var/run/docker.sock leoverto/docker-network-graph
+
+This will just generate and output the graph in the [DOT Language][dot].
+You can then paste that code into [GraphvizOnline][gvonline]
+to render it. The recommended rendering engine is `fdp`.
+
+Alternatively, if you prefer to render locally, you can run
+`fdp -Tpng -o out.png` on a system with graphviz installed,
+paste the previous output there, press enter and finally CTRL+C to
+generate the file.
+
+
+For more advanced use cases you can append arguments to the `docker run`
+command as if you were running it in a local shell.
+
+[dot]: https://www.graphviz.org/doc/info/lang.html
+[gvonline]: https://dreampuf.github.io/GraphvizOnline/
+
+## Development
+If you'd like to contribute to this project, there is a sample docker-compose file
+using dummy containers in `test`.
+
+You can deploy it using `docker-compose -f test/docker-compose.yml up -d`.