From 69393443ff2f1a76617d43274f44cd5f9ab372df Mon Sep 17 00:00:00 2001 From: Eddy Hintze Date: Sun, 4 Aug 2024 16:49:41 -0400 Subject: [PATCH] added docker image. Updated readme --- .gitlab-ci.yml | 1 - CHANGELOG.md | 1 + Dockerfile | 2 +- README.md | 10 ++++++++++ pyproject.toml | 2 +- 5 files changed, 13 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1ae1f23..bce7872 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -38,7 +38,6 @@ build_image: - docker:dind only: - main - - update script: - export VERSION=$(grep -m 1 version pyproject.toml | tr -s ' ' | tr -d '"' | tr -d "'" | cut -d' ' -f3) - export LATEST_IMAGE_TAG=ghcr.io/${GH_REGISTRY_USER}/humblebundle-downloader:latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c8b82c..24cc664 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ ## 0.4.2 - Added public docker image +- New version just to make sure the updated ci/cd pipeline is working, no code changes in this release ## 0.4.1 diff --git a/Dockerfile b/Dockerfile index 854d90d..f27e226 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,6 +6,6 @@ WORKDIR /app COPY . . -RUN poetry config virtualenvs.create false && poetry install --no-dev +RUN poetry config virtualenvs.create false && poetry install --only main ENTRYPOINT ["hbd"] diff --git a/README.md b/README.md index e5efe69..a640a71 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,18 @@ After that it will only download the content that has been updated or is missing ## Install + +### Using PIP + `pip install humblebundle-downloader` +### Using docker + +Remember to mount your download directory in the container using dockers `-v` argument. +`docker run ghcr.io/xtream1101/humblebundle-downloader -h` + + ## Instructions @@ -48,6 +57,7 @@ This can be done by getting a browser extension that lets you see or export your Use the following command to download your Humble Bundle Library: `hbd --cookie-file cookies.txt --library-path "Downloaded Library" --progress` +_If using the docker image, exclude the `hbd` part of the command_ This directory structure will be used: `Downloaded Library/Purchase Name/Item Name/downloaded_file.ext` diff --git a/pyproject.toml b/pyproject.toml index cfff64e..1bce2e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "humblebundle-downloader" -version = "0.4.1" +version = "0.4.2" description = "Download your Humble Bundle library" authors = ["Eddy Hintze "] license = "MIT"