Graceful fallback chrome missing

.github/workflows/test.yml

@@ -17,6 +17,18 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
     - uses: actions/checkout@v3
+    - name: Install macOS dependencies
+      if: matrix.os == 'macos-latest'
+      run: |
+        brew install cairo libxml2 libffi
+        echo "PKG_CONFIG_PATH=/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=/opt/homebrew/lib:$DYLD_LIBRARY_PATH" >> $GITHUB_ENV
+    - name: Install Windows dependencies
+      if: matrix.os == 'windows-latest'
+      run: |
+        choco install msys2 --yes
+        C:\tools\msys64\usr\bin\pacman -S --noconfirm mingw-w64-x86_64-cairo mingw-w64-x86_64-pkg-config
+        echo "C:\tools\msys64\mingw64\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
     - name: Install poetry
       run: pipx install poetry
     - name: Setup Python ${{ matrix.python-version }}

.gitignore

@@ -1,2 +1,7 @@
 __pycache__/
 .idea
+data-tests/
+.DS_Store
+src/rmc/assets/fonts/reMarkableSans.woff2
+src/rmc/assets/fonts/reMarkableSerif.woff2
+src/rmc/assets/fonts/reMarkableSerifItalic.woff2

README.md

@@ -1,42 +1,69 @@
 # rmc
 
-Command line tool for converting to/from remarkable `.rm` version 6 (software version 3) files.
+Command line tool for converting to/from remarkable `.rm` version 6 (software
+version 3) files.
 
 ## Installation
 
+If you want nice font rendering, you will need to install chrome/chromium (used
+to create svg/pdf with embedded fonts). Otherwise, rendering will fall back to
+using cairo. Chrome based rendering can also be turned off with `--no-chrome`.
+
 To install in your current Python environment:
 
     pip install rmc
 
-Or use [pipx](https://pypa.github.io/pipx/) to install in an isolated environment (recommended):
+Or use [pipx](https://pypa.github.io/pipx/) to install in an isolated
+environment (recommended):
 
     pipx install rmc
 
-## Usage
+To embed custom reMarkable fonts in the output, you will need to download them first:
 
-Convert a remarkable v6 file to other formats, specified by `-t FORMAT`:
+    cd ./src/rmc/assets/fonts/
+    ./download_remarkable_fonts.sh
 
-    $ rmc -t markdown file.rm
-    Text in the file is printed to standard output.
+## Usage
 
-Specify the filename to write the output to with `-o`:
+Convert rm to pdf:
 
-    $ rmc -t svg -o file.svg file.rm
-
-The format is guessed based on the filename if not specified:
-
     $ rmc file.rm -o file.pdf
 
-Create a `.rm` file containing the text in `text.md`:
+Convert rm to svg:
 
-    $ rmc -t rm text.md -o text.rm
+    $ rmc file.rm -o file.svg
+
+Convert a remarkable v6 file to other formats, specified by `-t FORMAT`:
 
-## SVG/PDF Conversion Status
+    $ rmc -t markdown file.rm -o file.md 
 
-Right now the converter works well while there are no text boxes. If you add text boxes, there are x issues:
+Create a `.rm` file containing the text in `text.md`:
+
+    $ rmc -t rm text.md -o text.rm
 
-1. if the text box contains multiple lines, the lines are actually printed in the same line, and
-2. the position of the strokes gets corrupted.
+```
+$ rmc --help
+Usage: rmc [OPTIONS] [INPUT]...
+
+  Convert to/from reMarkable v6 files.
+
+  Available FORMATs are: `rm` (reMarkable file), `markdown`, `svg`, `pdf`,
+  `blocks`, `blocks-data`.
+
+  Formats `blocks` and `blocks-data` dump the internal structure of the `rm`
+  file, with and without detailed data values respectively.
+
+Options:
+  --version            Show the version and exit.
+  -v, --verbose
+  -f, --from FORMAT    Format to convert from (default: guess from filename)
+  -t, --to FORMAT      Format to convert to (default: guess from filename)
+  -o, --output PATH    Output filename (default: write to standard out)
+  --no-chrome          Use Cairo instead of Chrome for PDF conversion
+  --chrome-loc PATH    Path to Chrome/Chromium binary
+  --device [RM2|RMPP]  Device type (overrides auto-detection)
+  --help               Show this message and exit.
+```
 
 # Acknowledgements
 

flake.nix

@@ -4,27 +4,43 @@
   inputs = {
     nixpkgs.url = "nixpkgs/nixpkgs-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    poetry2nix = { url = "github:nix-community/poetry2nix"; };
   };
 
-  outputs = { self, nixpkgs, flake-utils }: 
+  outputs = { self, nixpkgs, flake-utils, poetry2nix }:
     flake-utils.lib.eachDefaultSystem (system: 
       let
-        pythonEnv = pkgs.python312.withPackages (ps: []);
         pkgs = import nixpkgs {
           inherit system;
         };
+        inherit (poetry2nix.lib.mkPoetry2Nix { inherit pkgs; })
+          mkPoetryEnv mkPoetryApplication defaultPoetryOverrides;
+        poetryArgs = {
+          python = pkgs.python312;
+          projectDir = ./.;
+          preferWheels = true;
+          overrides = defaultPoetryOverrides.extend (final: prev: {
+            click = prev.click.overridePythonAttrs (old: {
+              buildInputs = (old.buildInputs or [ ]) ++ [ prev.flit-scm ];
+            });
+            rmc = prev.rmc.overridePythonAttrs (old: {
+              buildInputs = (old.buildInputs or [ ]) ++ [ prev.poetry-core ];
+            });
+          });
+        };
+        pythonEnv = mkPoetryEnv (poetryArgs);
+        rmcBin = mkPoetryApplication (poetryArgs);
       in
       {
+        packages = {
+          default = rmcBin;
+        };
         devShells.default = pkgs.mkShell {
-          buildInputs = with pkgs; [
-	    sqlite.dev
-	    poetry
-	    inkscape
+          buildInputs = [
+	        pkgs.poetry
+	        rmcBin
+	        pythonEnv
           ];
-
-	  LD_LIBRARY_PATH = pkgs.lib.makeLibraryPath [
-	    pkgs.sqlite.out
-	  ];
         };
       });
 }