Merge pull request #3 from SAnCherepan/develop

Added execution via docker

Author: SAnCherepan

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.github
+venv
+dist
+**/*.egg-info

.github/workflows/release.yml

@@ -13,7 +13,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
 
       - name: Set up Python
         uses: actions/setup-python@v3
@@ -35,4 +36,37 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/ 
+          repository_url: https://test.pypi.org/legacy/
+
+  deploy-docker:
+    runs-on: ubuntu-latest
+    if: github.ref_type == 'tag'
+
+    needs: deploy-pypi
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: sancherepan/repo-reader
+          flavor: latest=true
+          tags: type=semver,pattern={{version}}
+            
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -4,11 +4,16 @@ This is a simple example package that can be used to get basic info on GitHub re
 
 # Installation
 
-Install the python package:
-```
+Python package:
+```commandline
 python -m pip install --index-url https://test.pypi.org/simple/ repo_reader_sancherepan
 ```
 
+Docker image:
+```commandline
+docker pull sancherepan/repo-reader
+docker run -it --rm sancherepan/repo-reader read-repos --help
+```
 
 # Usage
 
@@ -24,3 +29,8 @@ In command line:
 ```commandline
 read-repos your_github_auth_token github_repo_group_name
 ```
+
+In docker:
+```commandline
+docker run -it --rm sancherepan/repo-reader read-repos your_github_auth_token github_repo_group_name
+```

docker/Dockerfile

@@ -1 +1,7 @@
-# ToDo: write Dockerfile
+FROM python:3.11
+
+COPY . /src
+
+RUN pip install /src && rm -rf /src
+
+CMD ["read-repos", "-h"]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "repo_reader_sancherepan"
-version = "0.2.1"
+version = "0.3.0"
 authors = [
   { name="SAnCherepan", email="sivkinpunk@gmail.com" },
 ]
@@ -15,12 +15,14 @@ requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 2 - Pre-Alpha",
     "Programming Language :: Python :: 3.11",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
+    "License :: OSI Approved :: MIT License"
+]
+dependencies = [
+    "requests"
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/sancherepan/test-code"
 
 [project.scripts]
-read-repos = "repo_reader_sancherepan.print_repos_info:main"
+read-repos = "repo_reader_sancherepan.print_repos_info:main"