Finalize port to Python 3 / Gtk 3

.flatpak/io.github.thinkle.Gourmet.yml

@@ -1,6 +1,6 @@
 app-id: io.github.thinkle.Gourmet
 runtime: org.gnome.Platform
-runtime-version: '3.36'
+runtime-version: '40'
 sdk: org.gnome.Sdk
 command: gourmet
 
@@ -40,11 +40,9 @@ modules:
       build-args:
         - --share=network
     build-commands:
-      - python3 -m pip install --upgrade pip
+      - python3 -m pip install --upgrade pip setuptools wheel
       - pip3 install pyenchant pygobject Sphinx
-      - pip3 install -r requirements.txt
-      - python3 setup.py build_i18n
-      - python3 setup.py install --prefix=/app
+      - pip3 install --prefix=/app .[epub-export,mycookbook,pdf-export,spellcheck,web-import]
       - install -Dm644 .flatpak/io.github.thinkle.Gourmet.desktop -t /app/share/applications/
       - install -Dm644 .flatpak/io.github.thinkle.Gourmet.svg -t /app/share/icons/hicolor/scalable/apps/
     sources:

.github/workflows/appimage.yml

@@ -0,0 +1,49 @@
+name: Create AppImage
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  AppImage:
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup AppImage Environment
+      run: |
+        sudo apt-get update -q
+        sudo apt-get -y install python3-testresources intltool imagemagick libgirepository1.0-dev
+        wget https://github.com/niess/python-appimage/releases/download/python3.8/python3.8.10-cp38-cp38-manylinux1_x86_64.AppImage
+        chmod +x ./python3.8.10-cp38-cp38-manylinux1_x86_64.AppImage
+        ./python3.8.10-cp38-cp38-manylinux1_x86_64.AppImage --appimage-extract
+        wget -c https://github.com/$(wget -q https://github.com/probonopd/go-appimage/releases -O - | grep "appimagetool-.*-x86_64.AppImage" | head -n 1 | cut -d '"' -f 2)
+        chmod +x appimagetool-*.AppImage
+
+    - name: Install Gourmet in AppImage
+      run: |
+          ./squashfs-root/AppRun -m pip install --upgrade pip
+          ./squashfs-root/AppRun -m pip install decorator six BeautifulSoup4 html5lib lxml pyenchant pygobject Sphinx
+
+          ./squashfs-root/AppRun setup.py bdist_wheel
+          ./squashfs-root/AppRun -m pip install .[epub-export,mycookbook,pdf-export,spellcheck,web-import]
+          ./squashfs-root/AppRun -m pip install dist/gourmet*.whl
+          sed -i -e 's|/opt/python3.8/bin/python3.8|/usr/bin/gourmet|g' ./squashfs-root/AppRun
+          rm squashfs-root/*.desktop
+          cp .flatpak/io.github.thinkle.Gourmet.desktop squashfs-root/usr/share/applications/io.github.thinkle.Gourmet.desktop
+          cp .flatpak/io.github.thinkle.Gourmet.desktop squashfs-root/
+          convert .flatpak/io.github.thinkle.Gourmet.svg squashfs-root/usr/share/icons/hicolor/256x256/apps/io.github.thinkle.Gourmet.png
+          convert .flatpak/io.github.thinkle.Gourmet.svg squashfs-root/io.github.thinkle.Gourmet.png
+
+    - name: Pack AppImage
+      run: |
+          VERSION=${GITHUB_SHA::8} ./appimagetool-*.AppImage squashfs-root/
+
+    - name: Upload AppImage
+      uses: actions/upload-artifact@v2
+      with:
+        name: gourmet.AppImage
+        path: ./Gourmet-*.AppImage

.github/workflows/build.yml

@@ -8,6 +8,7 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -17,34 +18,16 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
-    - name: Install Ubuntu dependencies
-      run: >
-        sudo apt-get update -q && sudo apt-get install
-        --no-install-recommends -y xvfb python3-dev python3-gi
-        python3-gi-cairo gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev
-        intltool enchant python3-enchant python3-gst-1.0
-
-    - name: Install dependencies
-      run: |
-        python3 -m pip install --upgrade pip
-        pip3 install --upgrade keyrings.alt
-        if [ -f requirements.txt ]; then pip3 install -r requirements.txt; fi
-
-    - name: Create Internationalization
+    - name: Setup build environment
       run: |
-          python3 setup.py build_i18n
-          find . | grep gourmet-plugin
-
-    - name: Install
-      run: |
-        pip3 install .
+        sudo apt-get update -q
+        sudo apt-get install python3-testresources intltool
+        sudo pip3 install --upgrade pip setuptools wheel
 
     - name: Create wheel and source distributions
       run: |
-          python3 setup.py sdist
+          python3 setup.py sdist bdist_wheel
           mv dist/gourmet-*.tar.gz dist/gourmet-${GITHUB_SHA::8}.tar.gz
-
-          python3 setup.py bdist_wheel
           mv dist/gourmet-*-py3-none-any.whl dist/gourmet-${GITHUB_SHA::8}-py3-none-any.whl
 
     - name: Upload artifacts

.github/workflows/flatpak.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Setup Flatpak
       run: |
         flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo
-        flatpak install flathub org.gnome.Platform//3.36 org.gnome.Sdk//3.36 -y
+        flatpak install flathub org.gnome.Platform//40 org.gnome.Sdk//40 -y
 
     - name: Build Flatpak
       run: |

.github/workflows/tests.yml

@@ -8,6 +8,7 @@ on:
     branches: [master]
   pull_request:
     branches: [master]
+  workflow_dispatch:
 
 jobs:
   test:
@@ -23,25 +24,22 @@ jobs:
         run: >
           sudo apt-get update -q && sudo apt-get install
           --no-install-recommends -y xvfb python3-dev python3-gi
-          python3-gi-cairo gir1.2-gtk-3.0 libgirepository1.0-dev
-          gir1.2-poppler-0.18 libcairo2-dev enchant python3-enchant intltool
-          python3-gst-1.0
+          python3-gi-cairo gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev
+          intltool enchant python3-enchant gir1.2-poppler-0.18 python3-gst-1.0
+          python3-testresources
 
-      - name: Install dependencies
+      - name: Install build dependencies
         run: |
-          sudo python3 -m pip install --upgrade pip
-          if [ -f development.txt ]; then sudo pip3 install -r development.txt; fi
-          sudo pip3 install --upgrade keyrings.alt
-          if [ -f requirements.txt ]; then sudo pip3 install -r requirements.txt; fi
+          sudo pip3 install --upgrade pip setuptools wheel
 
-      - name: Prepare plugins
-        run: |
-            python3 setup.py build_i18n
-            pip install .
+      - name: Install Gourmet
+        run: sudo pip3 install -r development.in
 
       - name: Test with pytest
-        run: xvfb-run -a pytest -vv gourmet/tests/test_*
+        run: LANGUAGE=de_DE.utf-8 xvfb-run -a pytest -vv tests/test_*
 
-        # - name: Test with mypy
-        #   run: mypy gourmet/
-        #   if: always()
+      - name: Check imports ordering
+        run: >
+          isort --diff src/**/*.py &&
+          isort -c src/**/*.py
+        if: always()

.gitignore

@@ -5,16 +5,18 @@ __pycache__/
 # Distribution / packaging
 *.egg-info/
 *.gourmet-plugin
+*.mo
 /build/
 /dist/
-gourmet.pot
 gourmet.appdata.xml
 gourmet.desktop
-po/.intltool-merge-cache
+/development.txt
+
 
 # Virtual environments
 /env/
 
+
 # Editors
 *.swp
 .idea/

CONTRIBUTING.md

@@ -1,54 +1,98 @@
-# Getting Started
-Install Gourmet's dependencies:
-
-    pip3 install -r requirements.txt
-    pip3 install -r development.txt
-
-`requirements.txt` contains the dependencies needed for Gourmet itself,
-`development.txt` contains the packages required for testing.
-
-Before you start development, you should first build localized *.mo and
-*.gourmet-plugin files within a build/ subdirectory of the source tree by
-running
-
-    python3 setup.py build_i18n
-
-You can then install Gourmet in edit mode so:
+# Contributing
 
-    pip3 install --user -e .
+Thank you for taking an interest in contributing to Gourmet! We appreciate that
+you're thinking about offering your time to improving the project, and it's our
+goal to respect your contribution accordingly.
 
-By doing so, you will be able to test your changes when launching Gourmet.
+Although this document focuses on code contributions, you can contribute in
+several ways:
+- File a bug report.
+- Add or improve documentation.
+- Promote the project to others.
 
-# Style
-New code follows the [PEP 8](http://www.python.org/dev/peps/pep-0008/) standard.  
 
-The following conventions are not strictly followed in Gourmet, old code
-should be reformatted only when modifying it.
+## Contributing Code
 
-# Getting the Source
-Gourmet's source code is hosted on [GitHub](https://github.com/thinkle/gourmet).
-You can clone it by opening a command prompt and typing:
+In general, the process for contributing code is:
 
-    git clone https://github.com/thinkle/gourmet.git
+1. Pick or open an [issue](https://github.com/thinkle/gourmet/issues) to work
+   on
+2. Post a comment expressing your intent to make sure nobody else is already
+   working on it
+3. Set up a development environment, as described below
+4. Hack the code, and when ready
+5. Push your changes to your forked repo and create a pull request.
 
-If you don't have any previous experience with Git, you might want to take a
-look at the [official Git tutorial](http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html),
-or the [GitHub Help pages](http://help.github.com/).
+Make sure to also check out our upcoming [milestones](https://github.com/thinkle/gourmet/milestones).
 
-# Contributing
-## Development
-If you'd like to contribute,
 
-1. [fork](https://github.com/thinkle/gourmet/fork) and clone the repository
-2. pick an [issue](https://github.com/thinkle/gourmet/issues) to work on
-3. post a little comment expressing your intent to make sure nobody else is
-   already working on it
-4. hack the code, and when ready
-5. push to your forked repo, and create a pull request.
+## Setting Up a Development Environment
+
+You'll want to clone Gourmet to your computer and probably
+[fork](https://github.com/thinkle/gourmet/fork) it as well.
+
+Ensure your system has the necessary prerequisites installed:
+- [Python](https://www.python.org/), which is what Gourmet is written in.
+- [PyGObject](https://pygobject.readthedocs.io/en/latest/) for GTK+ 3 and
+  other GNOME libraries. You may either install your system's `pygobject`
+  package(s) or install the necessary system requirements to install
+  `pygobject` from PyPI with `pip`. The latter method is recommended if you
+  plan on doing development within a Python virtual environment.
+- [intltool](https://freedesktop.org/wiki/Software/intltool/) for
+  internationalization.
+- (optional) [Enchant](https://abiword.github.io/enchant/) for spell-checking.
+  At least one of the backends must be installed as well.
+- (optional) [GStreamer](https://gstreamer.freedesktop.org/) for sound. The
+  GStreamer library itself and gst-plugins-base are required. Python bindings
+  are provided through PyGObject, so GObject introspection data is also needed.
+- (optional) [poppler](https://poppler.freedesktop.org/) for exporting PDFs.
+  Python bindings are provided through PyGObject, so install the GLIB bindings
+  and associated GObject introspection data.
+
+**Note:** Although some prerequisites are optional, the development install of
+Gourmet enables all plugins and features, so you probably want to install all
+prerequisites to avoid any issues.
+
+You may want to setup a [Python virtual
+environment](https://docs.python.org/3/library/venv.html). This is optional but
+highly recommended:
+```bash
+$ python -m venv --prompt gourmet env
+$ source env/bin/activate
+(gourmet) $ pip install -U pip setuptools wheel
+```
+
+Then install Gourmet itself:
+```bash
+(gourmet) $ pip install -r development.in
+```
+This installs the remaining Python dependencies and Gourmet itself in editable
+mode, which allows you to run Gourmet and see your changes without having to
+reinstall it.
+
+**Note:** If you encounter an error during the installation of
+`pygtkspellcheck`, first install `pyenchant` and `pygobject` on their own:
+```bash
+(gourmet) $ pip install pyenchant pygobject
+(gourmet) $ pip install -r development.in
+```
+
+You should now be able to launch and run Gourmet:
+```bash
+(gourmet) $ gourmet
+```
+
+
+## Style
+
+Gourmet is an old code base, consequently its style is not always consistent or
+conformant to contemporary tastes. We are not interested in bikeshedding, but
+please follow [PEP 8](http://www.python.org/dev/peps/pep-0008/) when writing new
+code, and when working on old code, please tidy up as you go.
 
-Make sure to also check out our upcoming [milestones](https://github.com/thinkle/gourmet/milestones).
 
 ## Issues and Suggestions
+
 We welcome feedback and issue reporting. You can do so by browsing existing
 issues and commenting on them, or creating a new one.