{"id":18380572,"url":"https://github.com/piyueh/totero","last_synced_at":"2025-08-29T06:27:40.106Z","repository":{"id":79981967,"uuid":"311795707","full_name":"piyueh/totero","owner":"piyueh","description":"A TUI client for Zotero","archived":false,"fork":false,"pushed_at":"2021-07-21T19:02:39.000Z","size":32,"stargazers_count":15,"open_issues_count":1,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-06T22:38:38.056Z","etag":null,"topics":["terminal","tui","urwid","zotero"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piyueh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-10T22:04:29.000Z","updated_at":"2024-10-31T11:03:59.000Z","dependencies_parsed_at":"2023-09-18T01:34:05.554Z","dependency_job_id":null,"html_url":"https://github.com/piyueh/totero","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/piyueh/totero","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piyueh%2Ftotero","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piyueh%2Ftotero/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piyueh%2Ftotero/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piyueh%2Ftotero/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piyueh","download_url":"https://codeload.github.com/piyueh/totero/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piyueh%2Ftotero/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272641693,"owners_count":24968804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-29T02:00:10.610Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["terminal","tui","urwid","zotero"],"created_at":"2024-11-06T00:43:02.770Z","updated_at":"2025-08-29T06:27:40.084Z","avatar_url":"https://github.com/piyueh.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"totero -- a TUI client for Zotero \n=================================\n\n-----------------------------------------------------------------------------\n\n**Note**:\nI don't have enough time to work on this, though I haven't completely given\nthis project up. Any contribution or/and collaboration are welcome!\n\n-----------------------------------------------------------------------------\n\n***totero*** is a TUI (text/terminal-based user interfaces) client for Zotero\nthat relies only on local database (i.e., no need for a cloud Zotero account).\nThe official Zotero GUI client is bundled with an old-version FireFox, which\ndoes not support Wayland. Under a Wayland environment, the official Zotero\nclient must rely on XWayland and does not look nice, especially with 4K and\nHiDPI monitors. So I decided to make my own client.\n\nTUI clients usually looks nice because most modern terminal emulators support\n256 colors or even 24-bit true colors. Here's a showcase of this\nclient in Sway WM:\n\n![totero_demo](https://pychao.com/wp-content/uploads/2020/11/totero_demo.gif)\n\n## Installation\n---------------\nThis is a WIP. No `pip` or `conda` packages.\n\nDependencies:\n\n* `python` \u003e= 3.7\n* `zoteroutils`: https://github.com/piyueh/zoteroutils\n* `pandas`\n* `sqlalchemy `(required by `zoteroutils`)\n* `urwid`\n\n`pandas`, `sqlalchemy` and `urwid` can be installed through whatever package\nmanagers preferred. `zoteroutils` is a companion package of `totero`, so it's\nalso a WIP and has to be downloaded manually:\n\n```\n$ git clone https://github.com/piyueh/zoteroutils\n```\n\nLet `python` know where to find `zoteroutils`:\n\n```\n$ export PYTHONPATH=\u003cpath to the zoteroutils\u003e:${PYTHONPATH}\n```\n\nThen download this client:\n\n```\n$ git clone https://github.com/piyueh/totero\n```\n\nFinally, run the client:\n\n```\n$ python \u003cpath to totero\u003e/totero.py \u003cpath to Zotero data folder\u003e\n```\n\n## Features\n-----------\n\n1. Pure Python -- easy to read and modified the code\n2. Using `xdg-open` to open attachments by `enter`. Poping up a window to choose\n   an attachment if multiple files exists for the selected document.\n3. Sorting with `F1` key. Poping up a window to choose which column(s) to sort.\n4. Selecting displayed columns with `F2` key. Poping up a window to choose column(s).\n4. Moving with `h`, `j`, `k`, and `l` keys\n5. Customizable color themes and key mappings. \n\n## TODO\n-------\n\nThese features are under development:\n\n1. Selecting a collection and showing documents in this collection\n2. Poping up a window to show the detail information of a selected document\n3. Searching\n4. A toolbar and a status bar\n5. Exporting to a bibtex file or a clipboard.\n\nThe following features are in the plan but probably won't be finished in the near\nfuture:\n\n1. Anything related to writing into the SQLite database. One reason is that I'm\n   not familiar with SQL. Another reason is that I may not have time.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiyueh%2Ftotero","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiyueh%2Ftotero","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiyueh%2Ftotero/lists"}