Merge pull request #13 from afonsoc12/develop

Develop

Author: afonsoc12

.dockerignore

@@ -1,5 +1,4 @@
 # Project files and folders
-.git
 .github
 test
 

.github/workflows/deploy_master.yml

@@ -70,6 +70,7 @@ jobs:
       - name: Login to DockerHub
         uses: docker/login-action@v1
         with:
+          registry: docker.io
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
       - name: Login to GitHub Container Registry
@@ -85,10 +86,10 @@ jobs:
           file: Dockerfile
           build-args: |
             VERSION=dev-v${{ env.VERSION }}
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/amd64,linux/arm64,linux/arm
           push: true
           tags: |
             afonsoc12/firefly-cli:dev-latest
-            afonsoc12/firefly-cli:dev-v${{ env.VERSION }}
+            afonsoc12/firefly-cli:dev-${{ env.VERSION }}
             ghcr.io/afonsoc12/firefly-cli:dev-latest
-            ghcr.io/afonsoc12/firefly-cli:dev-v${{ env.VERSION }}
+            ghcr.io/afonsoc12/firefly-cli:dev-${{ env.VERSION }}

.github/workflows/deploy_releases.yml

@@ -62,6 +62,7 @@ jobs:
       - name: Login to DockerHub
         uses: docker/login-action@v1
         with:
+          registry: docker.io
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
       - name: Login to GitHub Container Registry
@@ -78,10 +79,10 @@ jobs:
           build-args: |
             VERSION=${{ env.VERSION }}
           no-cache: true
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/amd64,linux/arm64,linux/arm
           push: true
           tags: |
             afonsoc12/firefly-cli:latest
-            afonsoc12/firefly-cli:v${{ env.VERSION }}
+            afonsoc12/firefly-cli:${{ env.VERSION }}
             ghcr.io/afonsoc12/firefly-cli:latest
-            ghcr.io/afonsoc12/firefly-cli:v${{ env.VERSION }}
+            ghcr.io/afonsoc12/firefly-cli:${{ env.VERSION }}

Dockerfile

@@ -1,23 +1,47 @@
-FROM python:3.8-alpine
+ARG DOCKER_IMAGE=python:3.9-alpine \
+    USER=nonroot \
+    GROUP=nonroot \
+    UID=1234 \
+    GID=4321
 
-LABEL maintainer="Afonso Costa (@afonsoc12)"
+# Install image
+FROM $DOCKER_IMAGE AS install-image
 
-ARG VERSION="n/a"
-ENV XDG_CONFIG_HOME=/config
-ENV TZ=Europe/Lisbon
-
-LABEL VERSION=${VERSION}
-
-WORKDIR /src
+WORKDIR /app
 
 COPY . .
 
-RUN apk update && \
-    apk add tzdata && \
-    echo -e "def get_versions():\n    return {'version': '${VERSION}', 'full-revisionid': 'n/a', 'date': 'n/a', 'dirty': 'n/a', 'error': 'n/a'}" \
-    > firefly_cli/_version.py && \
-    pip install --upgrade pip && \
-    pip install .
+RUN apk add --no-cache tzdata git \
+    && pip install --no-cache-dir --upgrade pip \
+    && pip install --user --no-cache-dir .
+
+# Runtime image
+FROM $DOCKER_IMAGE AS runtime-image
+
+ARG USER \
+    GROUP \
+    UID \
+    GID
+
+ENV PATH="/home/.local/bin:$PATH" \
+    XDG_CONFIG_HOME=/config \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+RUN mkdir -p /home $XDG_CONFIG_HOME \
+    && addgroup --gid $GID $GROUP \
+    && adduser -D -H --gecos "" \
+                     --home "/home" \
+                     --ingroup "$GROUP" \
+                     --uid "$UID" \
+                     "$USER" \
+    && chown -R $USER:$GROUP /home $XDG_CONFIG_HOME \
+    && rm -rf /tmp/* /var/{cache,log}/* /var/lib/apt/lists/*
+
+USER nonroot
+WORKDIR /home
+
+COPY --from=install-image --chown=$USER:$GROUP /root/.local /home/.local
 
 VOLUME /config
 

README.md

@@ -1,14 +1,14 @@
 <img src="https://www.firefly-iii.org/assets/logo/color.png" width="150">
 
 # Firefly III Command Line Interface
+[![Docker Pulls](https://img.shields.io/docker/pulls/afonsoc12/firefly-cli?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli)
 [![PyPi Version](https://img.shields.io/pypi/v/firefly-cli.svg)](https://pypi.org/project/firefly-cli/)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-<!-- [![Docker Pulls](https://img.shields.io/docker/pulls/afonsoc12/firefly-cli?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli) -->
 
-[![Github Starts](https://img.shields.io/github/stars/afonsoc12/firefly-cli?logo=github)](https://github.com/afonsoc12/firefly-cli)
-[![Github Fork](https://img.shields.io/github/forks/afonsoc12/firefly-cli?logo=github)](https://github.com/afonsoc12/firefly-cli)
 [![Github Release](https://img.shields.io/github/v/release/afonsoc12/firefly-cli?logo=github)](https://github.com/afonsoc12/firefly-cli/releases)
+[![Github Stars](https://img.shields.io/github/stars/afonsoc12/firefly-cli?logo=github)](https://github.com/afonsoc12/firefly-cli)
+[![Github Fork](https://img.shields.io/github/forks/afonsoc12/firefly-cli?logo=github)](https://github.com/afonsoc12/firefly-cli)
 
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 A python-based command line interface for conveniently entering expenses in [Firefly III](https://www.firefly-iii.org).
@@ -27,21 +27,23 @@ firefly-cli
 ```
 
 ## 2. Docker Image
-Currently, there are images for both `x86-64` and `arm64` architectures. 
+Currently, there are images for `x86-64`, `arm64` and `arm/v7` architectures.
 
-They are built from python's Linux Alpine base image (`python:3.7-alpine`) which makes the application very slim (less than 20MB). 
+They are built from python's Linux Alpine base image (`python:3.9-alpine`) which makes the application very slim (less than 20MB).
 
 | Architecture<br>[![Docker Image Size](https://img.shields.io/docker/image-size/afonsoc12/firefly-cli/latest?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli/tags?page=1&ordering=last_updated&name=latest) | Tag<br>[![Docker Dev Version](https://img.shields.io/docker/v/afonsoc12/firefly-cli/latest?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli/tags?page=1&ordering=last_updated&name=latest) |
-|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-|                                                                                                                    x86-64                                                                                                                     |                                                                                                         latest                                                                                                         |
-|                                                                                                                     arm64                                                                                                                     |                                                                                                         latest                                                                                                         |
+|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|                                                                                                                 x86-64                                                                                                                  |                                                                                                         latest                                                                                                         |
+|                                                                                                                  arm64                                                                                                                  |                                                                                                         latest                                                                                                         |
+|                                                                                                                  arm/v7                                                                                                                  |                                                                                                         latest                                                                                                         |
 
 There are also development images with the latest on master branch:
 
 | Architecture<br>[![Docker Image Size](https://img.shields.io/docker/image-size/afonsoc12/firefly-cli/latest?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli/tags?page=1&ordering=last_updated&name=dev-latest) | Tag<br>[![Docker Dev Version](https://img.shields.io/docker/v/afonsoc12/firefly-cli/dev-latest?logo=docker)](https://hub.docker.com/repository/docker/afonsoc12/firefly-cli/tags?page=1&ordering=last_updated&name=dev-latest) |
 |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
 |                                                                                                                   x86-64                                                                                                                    |                                                                                                               dev-latest                                                                                                               |
 |                                                                                                                    arm64                                                                                                                    |                                                                                                               dev-latest                                                                                                               |
+|                                                                                                                    arm/v7                                                                                                                    |                                                                                                               dev-latest                                                                                                               |
 
 Getting started with firefly-cli Docker:
 ```shell
@@ -98,13 +100,13 @@ python -m firefly_cli
 The CLI has two modes of operation:
 
 1. In one-line command style:
-    
+
 ```shell
 $ firefly-cli add 5.2, Large Mocha, Cash, Starbucks
 ```
-  
+
 2. Command Line Interface:
-  
+
 ```bash
 $ firefly-cli
 
@@ -162,9 +164,9 @@ api_token = eyXXX
 firefly-cli can override this behaviour and read/write from the file specified by the environment variable `FIREFLY_CLI_CONFIG`.
 
 # Commands
-The scope of this CLI is to enter expenses in a comma-separated style. 
+The scope of this CLI is to enter expenses in a comma-separated style.
 
-Starting in **[v0.1.0](https://github.com/afonsoc12/firefly-cli/releases/tag/v0.1.0)**, it now supports adding all possible transaction fields using optional arguments (e.g. `--source-name "Bank HSBC"`). 
+Starting in **[v0.1.0](https://github.com/afonsoc12/firefly-cli/releases/tag/v0.1.0)**, it now supports adding all possible transaction fields using optional arguments (e.g. `--source-name "Bank HSBC"`).
 The comma-separated arguments (aka positional arguments) are maintained for backwards-compatibility, but optional arguments will **always** override the comma-separated ones
 
 Summary of the available commands:
@@ -185,7 +187,7 @@ Summary of the available commands:
 ## Adding a transaction
 The command `add` is responsible for entering a new transaction in your Firefly instance. Further help can be shown by typing `add --help` or `help add`.
 
-By default, every transaction is a **withdrawal** and is placed with the current date and time. 
+By default, every transaction is a **withdrawal** and is placed with the current date and time.
 You may change transaction type by including the optional argument `--type`, change the transaction date with `--date yyyy-mm-dd` or if you would like to be more precise `--datetime yyyy-mm-ddTHH:MM:SS`.
 
 The comma-separated fields available are the following:

docker-compose-dev.yml

@@ -28,5 +28,6 @@ services:
       - MYSQL_USER=firefly
       - MYSQL_PASSWORD=firefly
       - MYSQL_DATABASE=firefly
+      - TZ=Europe/London
     ports:
       - 3306:3306

firefly_cli/__init__.py

@@ -2,15 +2,23 @@
 
 from firefly_cli._version import get_versions
 from firefly_cli.cli import FireflyPrompt
+from firefly_cli.parser import Parser
 
 __version__ = get_versions()["version"]
 
 
 def _real_main():
 
     if len(sys.argv) > 1:
+        args, ffargs = Parser.entrypoint().parse_known_args()
+
         try:
-            FireflyPrompt().onecmd(" ".join(sys.argv[1:]))
+            if args.version:
+                FireflyPrompt().onecmd("version")
+            elif args.help:
+                FireflyPrompt().onecmd("help")
+            else:
+                FireflyPrompt().onecmd(" ".join(ffargs))
         except Exception:
             raise
     else:
@@ -24,5 +32,5 @@ def main():
         print("\nInterrupted by user")
     except:
         # Silence raising exceptions
-        pass
-
+        raise
+        # pass

firefly_cli/__main__.py

@@ -16,4 +16,5 @@
 
 if __name__ == "__main__":
     import firefly_cli
+
     firefly_cli.main()

firefly_cli/_version.py

@@ -5,11 +5,12 @@
 # that just contains the computed version number.
 
 # This file is released into the public domain. Generated by
-# versioneer-0.21 (https://github.com/python-versioneer/python-versioneer)
+# versioneer-0.22 (https://github.com/python-versioneer/python-versioneer)
 
 """Git implementation of _version.py."""
 
 import errno
+import functools
 import os
 import re
 import subprocess
@@ -73,6 +74,14 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
     """Call the given command(s)."""
     assert isinstance(commands, list)
     process = None
+
+    popen_kwargs = {}
+    if sys.platform == "win32":
+        # This hides the console window if pythonw.exe is used
+        startupinfo = subprocess.STARTUPINFO()
+        startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
+        popen_kwargs["startupinfo"] = startupinfo
+
     for command in commands:
         try:
             dispcmd = str([command] + args)
@@ -83,6 +92,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
                 env=env,
                 stdout=subprocess.PIPE,
                 stderr=(subprocess.PIPE if hide_stderr else None),
+                **popen_kwargs
             )
             break
         except OSError:
@@ -244,30 +254,29 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
     version string, meaning we're inside a checked out source tree.
     """
     GITS = ["git"]
-    TAG_PREFIX_REGEX = "*"
     if sys.platform == "win32":
         GITS = ["git.cmd", "git.exe"]
-        TAG_PREFIX_REGEX = r"\*"
+
+    # GIT_DIR can interfere with correct operation of Versioneer.
+    # It may be intended to be passed to the Versioneer-versioned project,
+    # but that should not change where we get our version from.
+    env = os.environ.copy()
+    env.pop("GIT_DIR", None)
+    runner = functools.partial(runner, env=env)
 
     _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True)
     if rc != 0:
         if verbose:
             print("Directory %s not under git control" % root)
         raise NotThisMethod("'git rev-parse --git-dir' returned error")
 
+    MATCH_ARGS = ["--match", "%s*" % tag_prefix] if tag_prefix else []
+
     # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
     # if there isn't one, this yields HEX[-dirty] (no NUM)
     describe_out, rc = runner(
         GITS,
-        [
-            "describe",
-            "--tags",
-            "--dirty",
-            "--always",
-            "--long",
-            "--match",
-            "%s%s" % (tag_prefix, TAG_PREFIX_REGEX),
-        ],
+        ["describe", "--tags", "--dirty", "--always", "--long", *MATCH_ARGS],
         cwd=root,
     )
     # --long was added in git-1.5.5