nix flake

README.md

@@ -75,6 +75,15 @@ item key will be saved to a txt file.
 ```python
 zt_rw.readwise.save_failed_items_to_json("failed_readwise_highlights.json")
 ```
+
+## Approach 3 (through the nix flake)
+If you have `nix`, you can skip any installation and do:
+```sh
+nix run github:e-alizadeh/Zotero2Readwise -- <readwise_token> <zotero_key> <zotero_id>
+```
+The text file with failed highlights, which usually would be written to the Zotero2Readwise python package directory, will now be written to you working directory, since nix does not allow writing to package directories.
+If you don't want this file created, supply `--suppress_failures` as an additional argument.
+
 ---
 # [Zotero2Readwise-Sync](https://github.com/e-alizadeh/Zotero2Readwise-Sync)
 

flake.nix

@@ -0,0 +1,30 @@
+{
+  description = "Nix flake for running zotero2readwise script";
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+  inputs.poetry2nix.url = "github:nix-community/poetry2nix";
+
+  outputs = { self, nixpkgs, poetry2nix }:
+    let
+      system = "x86_64-linux";
+      pkgs = nixpkgs.legacyPackages.${system};
+      inherit (poetry2nix.lib.mkPoetry2Nix { inherit pkgs; }) mkPoetryApplication defaultPoetryOverrides;
+      zotero2readwise = mkPoetryApplication {
+        projectDir = ./.;
+        # Pyzotero requires setuptools.
+        # https://github.com/nix-community/poetry2nix/blob/master/docs/edgecases.md
+        overrides = defaultPoetryOverrides.extend (final: prev: {
+          pyzotero = prev.pyzotero.overridePythonAttrs ( old: {
+            buildInputs = (old.buildInputs or [ ]) ++ [ prev.setuptools ];
+          });
+        });
+      };
+    in
+    {
+      apps.${system}.default = {
+        type = "app";
+        # replace <script> with the name in the [tool.poetry.scripts] section of your pyproject.toml
+        program = "${zotero2readwise}/bin/run";
+      };
+    };
+}
+

pyproject.toml

@@ -38,12 +38,16 @@ env = "GH_TOKEN" # default env name containing the GitHub Token
 python = "^3.8"
 Pyzotero = "^1.4.26"
 requests = "^2.26.0"
+setuptools = ">= 45"  # necessary for python 3.12
 
 [tool.poetry.group.dev.dependencies]
 ipython = "^7.32.0"
 pre-commit = "^2.16.0"
 ipdb = "^0.13.9"
 
+[tool.poetry.scripts]
+run = "zotero2readwise.run:main"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

zotero2readwise/__init__.py

@@ -1,7 +1,10 @@
+import os
 from pathlib import Path
 
 __author__ = "Essi Alizadeh"
 __version__ = "0.4.5"
 
 TOP_DIR = Path(__file__).parent
-FAILED_ITEMS_DIR = TOP_DIR
+# If TOP_DIR is readonly os with nix,
+# then failed_zotero_items.json is written to the working directory instead.
+FAILED_ITEMS_DIR = TOP_DIR if os.access(TOP_DIR, os.W_OK) else Path.cwd()

zotero2readwise/run.py

@@ -5,7 +5,7 @@
 from zotero2readwise.zt2rw import Zotero2Readwise
 
 
-if __name__ == "__main__":
+def main():
     parser = ArgumentParser(description="Generate Markdown files")
     parser.add_argument(
         "readwise_token",
@@ -47,6 +47,11 @@
         action='store_true',
         help="Include Zotero items since last run"
     )
+    parser.add_argument(
+        "--suppress_failures",
+        action='store_true',
+        help="Do not write annotations that failed to port to a report file."
+    )
 
     args = vars(parser.parse_args())
 
@@ -68,8 +73,12 @@
         include_annotations=args["include_annotations"],
         include_notes=args["include_notes"],
         filter_colors=args["filter_color"],
-        since=since
+        since=since,
+        write_failures=not args["suppress_failures"]
     )
     zt2rw.run()
     if args["use_since"]:
-        write_library_version(zt2rw.zotero_client)
+        write_library_version(zt2rw.zotero_client)
+
+if __name__ == "__main__":
+    main()

zotero2readwise/zt2rw.py

@@ -17,7 +17,8 @@ def __init__(
         include_annotations: bool = True,
         include_notes: bool = False,
         filter_colors: List[str] = [],
-        since: int = 0
+        since: int = 0,
+        write_failures: bool = True
     ):
         self.readwise = Readwise(readwise_token)
         self.zotero_client = get_zotero_client(
@@ -29,6 +30,7 @@ def __init__(
         self.include_annots = include_annotations
         self.include_notes = include_notes
         self.since = since
+        self.write_failures = write_failures
 
     def get_all_zotero_items(self) -> List[Dict]:
             """
@@ -54,7 +56,7 @@ def run(self, zot_annots_notes: List[Dict] = None) -> None:
 
         formatted_items = self.zotero.format_items(zot_annots_notes)
 
-        if self.zotero.failed_items:
+        if self.write_failures and self.zotero.failed_items:
             self.zotero.save_failed_items_to_json("failed_zotero_items.json")
 
         self.readwise.post_zotero_annotations_to_readwise(formatted_items)
@@ -80,4 +82,4 @@ def retrieve_all(self, item_type: str, since: int = 0):
 
         print("It may take some time...")
         query = self.zotero_client.items(itemType={item_type}, since=since)
-        return self.zotero_client.everything(query)
+        return self.zotero_client.everything(query)