Update README.md

Make it a native package again

See merge request librem5-apps/librem5-goodies!25

Makefile

@@ -1,2 +1,13 @@
-all:
-	shellcheck contacts-importer
+APPDATA = \
+  sm.puri.librem5.goodies.appdata.xml \
+  $(NULL)
+
+all: shell-check appstream-check
+
+shell-check:
+	shellcheck l5-contacts-importer l5-screenshot l5-screen-recorder
+
+appstream-check:
+	appstream-util validate-relax $(APPDATA)
+
+.PHONY: all shell-check appstream-check

README.md

@@ -1,10 +1,12 @@
 # Librem 5 Goodies
 
-This project serves to create a deb package with several bash scripts created for the Librem 5 phone.
+This project serves to create a deb package with several temporary helper bash scripts created for the Librem 5 phone. 
 
 Bring your script here and it might be packaged :tada:
 
-Please Avoid scripts that require cloning and building packages from source.
+Please avoid scripts that require cloning and building packages from source.
+
+When one of these temporary helper scripts is no longer considered necessary, it will be removed (say if features provided by the script in question are added to `phosh`).
 
 #### Scripts added to this package:
 
@@ -12,10 +14,18 @@ Please Avoid scripts that require cloning and building packages from source.
 
 |Script | Description | Dependencies | Notes |
 |:--:|:--:|:--:|:--:|
-|Contacts Importer| Allows to import contacts from a vcard file to gnome contacts. Can work with a UI, from command line interface|`yad`, `syncevolution`, `libnotify-bin`| This script will cease to exist when this https://gitlab.gnome.org/GNOME/gnome-contacts/-/merge_requests/105 is merged into GNOME Contacts and this feature is present in GNOME Contacts. |
+|Contacts Importer| Allows to import contacts from a vcard file to GNOME Contacts. Can work with a UI and from command line interface|`yad`, `syncevolution`, `libnotify-bin`, `Evolution Data Server`| This script will be removed from this paclage when the version of GNOME-Contacts available in PureOS supports importing contacts from a vcard file. |
+|Screenshot| Allows to take screenshots in the Librem 5 phone|`yad`, `grim`, `libnotify-bin`, `xdg-user-dirs`| This script will be removed from this package when there is a native app that can take screenshots in `Phosh`. |
+|Screen recorder | A simple application to record the screen| `wf-recorder`, `yad`, `libnotify-bin` | This script will be removed from this package when `phosh` has better support for recording.|
+
+**Previously removed scripts:**
+
+- Scale the screen: A simple application to scale the screen. This is now supported in `phosh`.
 
 #### Adding a script to this package:
 
-- Make a new branch based on the master branch and work from it.
-- Make a merge request
-- Avoid scripts that download and build source code
+- Make a new branch based on the `pureos/latest` branch and work from it.
+- Make a merge request.
+- Avoid scripts that download and build source code. If you need a dependency not available in PureOS, package it :D
+- If your script stores files somewhere, then please use `xdg-user-dir` to set the path instead of harcoding directory names like "Documents", "Videos", this is usefull because not all users have their OS in English. See example here; https://source.puri.sm/librem5-apps/librem5-goodies/-/blob/pureos/byzantium/l5-screenshot#L27 `xdg-user-dir` is also quite usefull
+- if you are not confortable in commiting to a Deb package then open an issue asking for the script to be packaged and we will work it out

contacts-importer.desktop

@@ -1,7 +0,0 @@
-[Desktop Entry]
-Name=Contacts Importer
-Type=Application
-Icon=preferences-desktop-personal
-Exec=/usr/bin/contacts-importer %U
-Categories=Utility;
-MimeType=text/x-vcard;

debian/changelog

@@ -1,6 +1,93 @@
+librem5-goodies (0.0.7pureos1) byzantium; urgency=medium
+
+  [ Guido Günther ]
+  * Make it a native package again.
+    There's no upstream other than us afaik.
+  * ci: Drop check-tarball.
+    Not needed (and hence not working) for a 3.0 (native) package
+
+ -- Guido Günther <agx@sigxcpu.org>  Sat, 30 Oct 2021 15:40:47 +0200
+
+librem5-goodies (0.0.7-1pureos2) byzantium; urgency=medium
+
+  [ João Azevedo ]
+  * Prepare release to byzantium.
+      - Update CI
+      - New release number 
+      - Increase debhelper version to 13
+
+ -- João Azevedo <joao.azevedo@puri.sm>  Sat, 30 Oct 2021 00:36:54 +0200
+
+librem5-goodies (0.0.7pureos1) amber-phone; urgency=medium
+  
+  [ João Azevedo ]
+  * New upstream release.
+      - Remove scale the screen script, closes #15
+      - Remove wl-randr as a dependency as it is no longer required
+      - Update packge discription to include l5-screen-recorder
+      - Update appdata file to include the l5-screen-recorder
+      - Add l5-screen-recorder to makefile build tests
+      - Fix shellcheck warning with l5-screen-recorder
+      - Add usage function to l5-screen-recorder
+      - Add l5-screen-recorder icon to notifications
+      - Add l5-screen-recorder to build tests
+      - Update debhelper version
+      
+  [ David Hamner ] 
+  * Add l5-screen-recorder:
+      - Add l5-screen-recorder script and l5-screen-recorder desktop file
+      - Add wf-recorder as a dependency required by l5-screen-recorder
+      - Add paths for l5-screen-recorder in librem5-goodies.install file
+      
+ -- João Azevedo <joao.azevedo@puri.sm>  Fri, 29 Oct 2021 23:28:46 +0200
+
+librem5-goodies (0.0.6pureos1) amber-phone; urgency=medium
+
+  * Non-maintainer upload.
+  * Use a PureOS compatible version tag
+
+ -- Guido Günther <agx@sigxcpu.org>  Wed, 01 Sep 2021 10:38:26 +0200
+
+librem5-goodies (0.0.6) amber-phone; urgency=medium
+
+  * New upstream release.
+      - Make screenshot script l10n friendy, closes: #13
+      - d/control: add dependency; xdg-user-dirs
+      - Add scale the screens support for QEMU image closes: #12
+
+ -- João Azevedo <joao.azevedo@puri.sm>  Sun, 18 Apr 2021 13:33:50 +0200
+
+librem5-goodies (0.0.5) amber-phone; urgency=medium
+
+  * New upstream release.
+      - added tags in the desktop files for then to be visible in phosh
+      - Added appstream metadata file 
+      - Added Scale the screen script
+      - Updated the control file and dependencies
+      - Updated changelog file
+      - Updated README file
+
+ -- João Azevedo <joao.azevedo@puri.sm>  Mon, 23 Nov 2020 13:26:52 +0100
+
+librem5-goodies (0.0.4) amber-phone; urgency=medium
+
+  * New upstream release.
+      - replaced zenity with yad in the screenshot script
+      - changed the scripts names to have the prefix l5-
+      - Updated README file
+
+ -- João Azevedo <joao.azevedo@puri.sm>  Tue, 04 Aug 2020 22:17:24 +0200
+
+librem5-goodies (0.0.3) amber-phone; urgency=medium
+
+  * New upstream release.
+      - Added the script: screenshot
+
+ -- João Azevedo <joao.azevedo@puri.sm>  Tue, 04 Aug 2020 22:17:24 +0200
+
 librem5-goodies (0.0.2) amber-phone; urgency=medium
 
-  * New upstream release. 
+  * New upstream release.
       - Changed the project name.
       - Changed the target repo to amber-phone.
 
@@ -8,6 +95,6 @@ librem5-goodies (0.0.2) amber-phone; urgency=medium
 
 contacts-importer (0.0.1) byzantium; urgency=medium
 
-  * Initial release. 
+  * Initial release.
 
  -- João Azevedo <joao.azevedo@puri.sm>  Fri, 19 Jun 2020 13:47:46 +0200

debian/contacts-importer.install

@@ -1,2 +0,0 @@
-contacts-importer /usr/bin
-contacts-importer.desktop /usr/share/applications

debian/control

@@ -3,23 +3,29 @@ Section: comm
 Priority: optional
 Maintainer: João Azevedo <joao.azevedo@puri.sm>
 Build-Depends:
- debhelper-compat (= 12),
+ appstream-util,
+ debhelper-compat (= 13),
  shellcheck,
-Homepage: https://source.puri.sm/librem5-apps/diy-contacts-importer
-Vcs-Git: https://source.puri.sm/librem5-apps/diy-contacts-importer.git
-Vcs-Browser: https://source.puri.sm/librem5-apps/diy-contacts-importer
+Homepage: https://source.puri.sm/librem5-apps/librem5-goodies
+Vcs-Git: https://source.puri.sm/librem5-apps/librem5-goodies.git
+Vcs-Browser: https://source.puri.sm/librem5-apps/librem5-goodies
 Standards-Version: 4.3.0
 
 Package: librem5-goodies
 Architecture: all
 Depends:
  evolution-data-server,
+ grim,
  libnotify-bin,
  syncevolution,
  yad,
+ xdg-user-dirs,
+ wf-recorder,
  ${misc:Depends},
 Description: Librem 5 Goodies
- A collection of bash scripts and applications made to add functionalities to 
+ A collection of bash scripts and applications made to add functionalities to
  the Librem 5 phone and Phosh Shell. It includes the following:
- - Contacts Importer: A simple application to import contacts from a vcard file
- to GNOME Contacts.
+  - L5 Contacts Importer: A simple application to import contacts from a vcard
+    file to GNOME Contacts.
+  - L5 Screenshot: A simple application to make screenshots on the Librem 5
+  - L5 Screen Recorder: A simple application to record the Librem 5 screen

debian/copyright

@@ -1,5 +1,5 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Source: https://source.puri.sm/librem5-apps/diy-contacts-importer
+Source: https://source.puri.sm/librem5-apps/librem5-goodies
 Upstream-Name: librem5-goodies
 
 Files: *

debian/files

@@ -1,2 +0,0 @@
-contacts-importer_0.0.1_all.deb comm optional
-contacts-importer_0.0.1_amd64.buildinfo comm optional

debian/librem5-ci.yml

@@ -1,19 +1,9 @@
 include:
  - 'https://source.puri.sm/Librem5/librem5-ci/raw/master/librem5-pipeline-definitions.yml'
+ - 'https://source.puri.sm/Librem5/librem5-ci/raw/master/librem5-pipeline-byzantium-jobs.yml'
 
 stages:
  - package
  - test-package
 
-package:deb-debian-buster:
-  extends: .l5-build-debian-package
 
-autopkgtest-debian-buster-package:
-  dependencies:
-    - package:deb-debian-buster
-  extends: .l5-autopkgtest-debian-package
-
-lintian-debian-buster-package:
-  dependencies:
-    - package:deb-debian-buster
-  extends: .l5-lintian-debian-package

debian/librem5-goodies.install

@@ -1,2 +1,7 @@
-contacts-importer /usr/bin
-contacts-importer.desktop /usr/share/applications
+l5-contacts-importer /usr/bin
+l5-contacts-importer.desktop /usr/share/applications
+l5-screenshot /usr/bin
+l5-screenshot.desktop /usr/share/applications
+l5-screen-recorder /usr/bin
+l5-screen-recorder.desktop /usr/share/applications
+sm.puri.librem5.goodies.appdata.xml /usr/share/metainfo

debian/rules

@@ -5,3 +5,4 @@
 
 override_dh_auto_test:
 	make
+

debian/tests/control

@@ -1,4 +1,3 @@
-Test-Command: /usr/bin/contacts-importer --help
+Test-Command: /usr/bin/l5-contacts-importer --help && /usr/bin/l5-screenshot --help && l5-screen-recorder --help
 Restrictions: superficial
-Depends:
- contacts-importer,
+Depends: librem5-goodies

gbp.conf

@@ -0,0 +1,9 @@
+[DEFAULT]
+debian-branch = pureos/byzantium
+debian-tag = pureos/%(version)s
+upstream-tag = v%(version)s
+upstream-branch = master
+pristine-tar = True
+
+[tag]
+sign-tags = True

l5-contacts-importer.desktop

@@ -0,0 +1,10 @@
+[Desktop Entry]
+Name=Contacts Importer
+Type=Application
+Icon=preferences-desktop-personal
+Exec=/usr/bin/l5-contacts-importer %U
+Categories=Utility;
+MimeType=text/x-vcard;
+# Translators: Do NOT translate or transliterate this text (these are enum types)!
+X-Purism-FormFactor=Workstation;Mobile;
+

l5-screen-recorder

@@ -0,0 +1,40 @@
+#!/bin/bash
+# GPL3
+
+function usage()
+{
+  echo "Usage: Just press the Screen Shot Icon in the app tray"
+  exit 0
+}
+
+NOTIFY_SEND="notify-send -i emblem-videos-symbolic"
+
+case "$1" in
+   --help|-h|-?)
+     usage
+   ;;
+esac
+
+VIDEO="$(xdg-user-dir VIDEOS)/$(date +%Y-%m-%d-%H%M%S).avi"
+yad --title ScreenCapture --text "A simple GUI to record the screen" --button="Start capture:100" --button="Quit:0" --buttons-layout=center
+start_window_return=$?
+
+if [[ $start_window_return -eq 100 ]]
+then
+    wf-recorder -a -f "$VIDEO" --codec=asv1 &
+else
+    exit
+fi
+
+yad --title ScreenCapture --text "Screen capture is actively running. \\nFile: $VIDEO" --button='Stop capture:100' --buttons-layout=center
+exit_window_return=$?
+
+if [[ $exit_window_return -eq 100 ]]
+then
+    killall -2 wf-recorder
+fi
+
+if test -f "$VIDEO"
+then
+    $NOTIFY_SEND ScreenCapture "Video stored at $VIDEO"
+fi

l5-screen-recorder.desktop

@@ -0,0 +1,8 @@
+[Desktop Entry]
+Name=Screen Recorder
+Type=Application
+Icon=emblem-videos-symbolic
+Exec=/usr/bin/l5-screen-recorder
+Categories=Utility;
+# Translators: Do NOT translate or transliterate this text (these are enum types)!
+X-Purism-FormFactor=Workstation;Mobile;

l5-screenshot

@@ -0,0 +1,44 @@
+#!/bin/bash
+# This screenshot program was based on an initial command-line only version
+# by the purismforum user in community/librem-5
+#
+# I've since expanded it to use libnotify and provide a GUI
+# It requires the grim, libnotify-bin and yad packages:
+# sudo apt install grim yad libnotify-bin
+
+# Adding usage information and Icon to libnotify
+
+function usage()
+{
+  echo "Usage: $0, or just press the Screen Shot Icon in the app tray"
+  exit 0
+}
+
+NOTIFY_SEND="notify-send -i applets-screenshooter"
+
+case "$1" in
+   --help|-h|-?)
+     usage
+   ;;
+esac
+
+#Variable
+
+SCREENSHOT="$(xdg-user-dir PICTURES)/$(date +%Y-%m-%d-%H%M%S).png"
+
+if [ -e /usr/bin/yad ]; then
+  INPUT=$(yad --title Screenshot --text="Take screenshot after X seconds" --form --field=filename:SFL --field=seconds:NUM "$SCREENSHOT" "5" --focus-field=2)
+  echo "$INPUT"
+  SCREENSHOT=$(echo "$INPUT" | cut -d '|' -f1)
+  SECONDS=$(echo "$INPUT" | cut -d '|' -f2)
+else
+  SECONDS=$(yad --title Screenshot --text="Take screenshot after X seconds" --entry-text=5 --entry)
+fi
+
+if [ "$SECONDS" -eq 0 ]; then
+  exit
+fi
+$NOTIFY_SEND -t 1000 screenshot "Taking a screenshot in $SECONDS seconds"
+sleep "$SECONDS";
+grim "$SCREENSHOT"
+$NOTIFY_SEND screenshot "Screenshot stored at ${SCREENSHOT}"

l5-screenshot.desktop

@@ -0,0 +1,9 @@
+[Desktop Entry]
+Name=Screen Shot
+Type=Application
+Icon=applets-screenshooter
+Exec=/usr/bin/l5-screenshot %U
+Categories=Utility;
+# Translators: Do NOT translate or transliterate this text (these are enum types)!
+X-Purism-FormFactor=Workstation;Mobile;
+

sm.puri.librem5.goodies.appdata.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright 2018-2019 Purism, SPC -->
+<component type="desktop-application">
+  <id>sm.puri.librem5.goodies</id>
+  <metadata_license>gpl-3+</metadata_license>
+  <project_license>GPL-3.0+</project_license>
+  <name>Librem 5 Goodies</name>
+  <summary>A collection of bash scripts for the Librem 5</summary>
+
+  <description>
+    <p>Librem5 Goodies contains the following scripts:</p>
+    <p>- Contacts importer: An application to import contacts from a vcard</p> 
+    <p>- Screen Shot: An application to make screenshots of the Librem 5</p>
+    <p>- Screen recorder: An application to record the Librem 5 screen</p> 
+  </description>
+  <url type="homepage">https://source.puri.sm/librem5-apps/librem5-goodies/</url>
+  <developer_name>Purism Developers</developer_name>
+  
+  <update_contact>support@puri.sm</update_contact>
+
+  <custom>
+    <value key="Purism::form_factor">workstation</value>
+    <value key="Purism::form_factor">mobile</value>
+  </custom>
+
+  <provides>
+    <binary>librem5-goodies</binary>
+  </provides>
+
+</component>
+