DOT-6167 Prepare Dockerfile for dokku

.dockerignore

@@ -0,0 +1,9 @@
+*
+!rembg
+!setup.py
+!setup.cfg
+!requirements.txt
+!requirements-cpu.txt
+!requirements-gpu.txt
+!versioneer.py
+!README.md

.gitattributes

@@ -0,0 +1 @@
+rembg/_version.py export-subst

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: [danielgatis]
+custom: ["https://www.buymeacoffee.com/danielgatis"]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] ..."
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Images**
+Input images to reproduce.
+
+**OS Version:**
+iOS 22
+
+**Rembg version:**
+v2.0.21
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] ..."
+labels: enhancement
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/close_inactive_issues.yml

@@ -0,0 +1,23 @@
+name: Close inactive issues
+
+on:
+    schedule:
+        - cron: "30 1 * * *"
+
+jobs:
+    close-issues:
+        runs-on: ubuntu-latest
+        permissions:
+            issues: write
+            pull-requests: write
+        steps:
+            - uses: actions/stale@v5
+              with:
+                  days-before-issue-stale: 30
+                  days-before-issue-close: 14
+                  stale-issue-label: "stale"
+                  stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+                  close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+                  days-before-pr-stale: -1
+                  days-before-pr-close: -1
+                  repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint_python.yml

@@ -0,0 +1,19 @@
+name: Lint
+
+on: [pull_request, push]
+
+jobs:
+    lint_python:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-python@v4
+              with:
+                python-version: 3.11
+            - name: Install dependencies
+              run: pip install .[cli,dev]
+            - run: mypy --install-types --non-interactive --ignore-missing-imports ./rembg
+            - run: bandit --recursive --skip B101,B104,B310,B311,B303,B110 --exclude ./rembg/_version.py ./rembg
+            - run: black --force-exclude rembg/_version.py --check --diff ./rembg
+            - run: flake8 ./rembg --count --ignore=B008,C901,E203,E266,E731,F401,F811,F841,W503 --max-line-length=120 --show-source --statistics --exclude ./rembg/_version.py
+            - run: isort --check-only --profile black ./rembg

.github/workflows/publish_docker.yml

@@ -0,0 +1,59 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ${{ secrets.DOCKER_HUB_USERNAME }}/rembg
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=ref,event=branch
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=registry,ref=${{ secrets.DOCKER_HUB_USERNAME }}/rembg:buildcache
+          cache-to: type=registry,ref=${{ secrets.DOCKER_HUB_USERNAME }}/rembg:buildcache,mode=max

.github/workflows/publish_pypi.yml

@@ -0,0 +1,24 @@
+name: Publish to Pypi
+
+on:
+    push:
+        tags:
+            - "v*.*.*"
+
+jobs:
+    push_to_pypi:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-python@v4
+              with:
+                python-version: 3.11
+            - name: Install dependencies
+              run: pip install .[cli,dev]
+            - name: Builds and uploads to PyPI
+              run: |
+                  python3 setup.py sdist bdist_wheel
+                  python3 -m twine upload dist/*
+              env:
+                  TWINE_USERNAME: __token__
+                  TWINE_PASSWORD: ${{ secrets.PIPY_PASSWORD }}

.github/workflows/test-install.yml

@@ -0,0 +1,22 @@
+name: Test installation
+
+on: [push]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install dependencies
+              run: pip install .[cli,dev]
+            - name: Test installation with pytest
+              run: |
+                  pytest

.gitignore

@@ -1,13 +1,21 @@
 # general things to ignore
 build/
 dist/
+.venv/
+.direnv/
+*.spec
 *.egg-info/
 *.egg
 *.py[cod]
 __pycache__/
 *.so
-*~
+*~≈
+.envrc
+.python-version
+.idea
+.pytest_cache
 
 # due to using tox and pytest
 .tox
 .cache
+.mypy_cache

Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.10-slim
+
+WORKDIR /rembg
+
+COPY . .
+
+RUN python -m pip install -r requirements.txt
+RUN python -m pip install ".[cli]"
+RUN python -c 'from rembg.bg import download_models; download_models()'
+
+EXPOSE 5000
+ENTRYPOINT ["rembg"]
+CMD ["s", "-t 8"]

MANIFEST.in

@@ -1,12 +1,10 @@
-include pyproject.toml
-
-# Include the README
-include *.md
-
-# Include the license file
+include MANIFEST.in
 include LICENSE.txt
-
-# Include the data files
-recursive-include data *
-
+include README.md
+include setup.py
+include pyproject.toml
 include requirements.txt
+include requirements-gpu.txt
+
+include versioneer.py
+include rembg/_version.py

Makefile

@@ -0,0 +1,61 @@
+# keep help at the beginning - this will be used as default command
+.description: Generate list of targets with descriptions
+help:
+	@grep -oz '^.description: .*\n.*:' Makefile | sed 'N;s;\.description: \(.*\)\n\(.*\):;"\x1b[1\;32m make \2 \x1b[0m" "\1";' | xargs printf "%-50s - %s\n"
+
+# MACROS
+
+DOCKER = docker-compose -f docker-compose.development.yml
+DOCKER_DEV = $(DOCKER)
+CFLAGS='-Wno-warning'
+
+# use the rest as arguments for "run"
+ARGS = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
+
+# COMMANDS
+
+# common
+.description: start all services in DEVELOPMENT environment
+start:
+	make stop backend
+	$(DOCKER_DEV) --profile all up -d
+
+.description: stop all app services. You can pass service name as an argument
+stop:
+	$(DOCKER) --profile all stop $(call ARGS)
+
+.description: stop all services
+down:
+	$(DOCKER) --profile all down
+
+.description: build docker images
+build:
+	$(DOCKER_DEV) --profile all build
+
+.description: docker logs with follow option. You can pass service name as argument.
+flogs:
+	$(DOCKER) logs --follow $(call ARGS)
+
+.description: docker logs. You can pass service name as argument.
+logs:
+	$(DOCKER) logs $(call ARGS)
+
+.description: exec in the running service (pass service name and command as an argument). `make exec redis redis-cli`
+exec:
+	$(DOCKER) exec $(call ARGS)
+
+.description: attaches to backend process stdin
+attach:
+	docker attach --detach-keys=ctrl-c $$($(DOCKER_DEV) ps -q backend)
+
+.description: launches bash in backend container
+bash:
+	$(DOCKER_DEV) exec backend bash
+
+# Ignore unknown targets
+%:
+	@:
+
+# ...and turn them into do-nothing targets
+_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+$(eval $(_ARGS):dummy;@:)