Merge pull request #28 from victorlpgazolli/master

.github/workflows/publish_docker.yml

@@ -0,0 +1,43 @@
+# https://docs.github.com/en/actions/publishing-packages/publishing-docker-images#publishing-images-to-github-packages
+name: Create and publish a Docker image to GitHub Registry
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: ${{ github.repository }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      USERNAME: ${{ github.actor }}
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ env.USERNAME }}
+          password: ${{ env.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.10-alpine
+
+WORKDIR /app
+
+RUN apk update && \
+    apk upgrade && \
+    apk add gcc libc-dev libffi-dev cargo && \
+    python -m pip install --upgrade pip && \
+    pip install poetry 
+
+
+COPY ["pyproject.toml", "./"]
+
+RUN poetry install 
+
+COPY . .
+
+RUN pip install .
+
+CMD [ "mitmproxy2swagger" ]
+

README.md

@@ -26,6 +26,10 @@ First you will need python3 and pip3.
 $ pip install mitmproxy2swagger 
 # ... or ...
 $ pip3 install mitmproxy2swagger
+# ... or ...
+$ git clone git@github.com:alufers/mitmproxy2swagger.git
+$ cd mitmproxy2swagger
+$ docker build -t mitmproxy2swagger .
 ```
 
 Then clone the repo and run `mitmproxy2swagger` as per examples below.
@@ -58,6 +62,8 @@ To create a specification by inspecting HTTP traffic you will need to:
 
     ```bash
     $ mitmproxy2swagger -i <path_to_mitmptoxy_flow> -o <path_to_output_schema> -p <api_prefix>
+    # ... or ...
+    $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <path_to_mitmptoxy_flow> -o <path_to_output_schema> -p <api_prefix>
     ```
 
     Please note that you can use an existing schema, in which case the existing schema will be extended with the new data. You can also run it a few times with different flow captures, the captured data will be safely merged.
@@ -94,6 +100,8 @@ To create a specification by inspecting HTTP traffic you will need to:
 
     ```bash
     $ mitmproxy2swagger -i <path_to_mitmptoxy_flow> -o <path_to_output_schema> -p <api_prefix> [--examples]
+    # ... or ...
+    $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <path_to_mitmptoxy_flow> -o <path_to_output_schema> -p <api_prefix> [--examples]
     ```
 
     Run the command a second time (with the same schema file). It will pick up the edited lines and generate endpoint descriptions.