{"id":16897042,"url":"https://github.com/bytesnake/pap","last_synced_at":"2025-03-20T11:16:54.164Z","repository":{"id":142257099,"uuid":"365949610","full_name":"bytesnake/pap","owner":"bytesnake","description":"Paper mangement","archived":false,"fork":false,"pushed_at":"2021-06-04T16:56:43.000Z","size":89,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-25T11:29:15.924Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bytesnake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE2","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":"2021-05-10T07:06:29.000Z","updated_at":"2024-10-23T09:21:05.000Z","dependencies_parsed_at":"2023-05-02T05:02:28.878Z","dependency_job_id":null,"html_url":"https://github.com/bytesnake/pap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fpap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fpap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fpap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fpap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bytesnake","download_url":"https://codeload.github.com/bytesnake/pap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244600724,"owners_count":20479307,"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","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":[],"created_at":"2024-10-13T17:34:32.515Z","updated_at":"2025-03-20T11:16:54.128Z","avatar_url":"https://github.com/bytesnake.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Paper threading\n\n[![crates.io](https://img.shields.io/crates/v/pap.svg)](https://crates.io/crates/pap)\n\npap is a paper threading tool for the command line. It offers a simple interface for adding metadata and querying reading status. The workflow is opinionated, dividing into four different stages and tailored to the author's use.\n\n\u003cimg src=\"example.png\"\u003e\u003c/img\u003e\n\n## Installation\n\nYou can install `pap` with\n\n```\ncargo install pap\n```\n\n## How-to use\n\nCurrently my reading consists of four stages:\n * I  - added but auxiliary sources have to be read first\n * II - read and compressed on a piece of paper or whiteboard\n * III - recalled or explained to somebody else, looked into open-review\n * IV - feed-back from publication venue, textual results or reversed-citation graph\n\nTo setup the project create a subfolder with an empty `.pap.toml` file, e.g.\n```bash\n$ mkdir papers/\n$ touch papers/.pap.toml\n```\nthe tool will look through all sub-directories and select the first found workspace.\n\nYou can add a new paper with `pap add`. This will open a template for you in vim and let you fill in title, abstract etc. An associated hash is generated from the title and the metadata written to a folder with this hash, e.g. `papers/\u003chash\u003e/index.toml`. If you want to use a hash, you only have to specify as many symbols as necessary to disambiguate it from other paper's hashes. (similar to git)\n\nYou can view your history with `pap view \u003cpattern\u003e`, this prints progress and title with corresponding hash. Only a sequential view is available at the moment, graph views may be added later.\n\nA new stage can be marked with `pap mark \u003chash fragment\u003e \u003cprogress\u003e` with progress one of `(I | II | III | IV)`. After updating the stage the paper should appear at the bottom of the sequential list.\n\nI'm adding the full-text paper to `papers/\u003chash\u003e/index.pdf`, but no prior path is defined in the tool and you can use arbitrary file names for primary source, artifacts etc.\n\nAnd of course I encourage you to manage everything with git as this will simplify your working flow and let you share your reading list.\n\n# License\n\nDual-licensed to be compatible with the Rust project.\n\nLicensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0 or the MIT license http://opensource.org/licenses/MIT, at your option. This file may not be copied, modified, or distributed except according to those terms.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesnake%2Fpap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytesnake%2Fpap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesnake%2Fpap/lists"}