{"id":29204687,"url":"https://github.com/thiswillbeyourgithub/freshrss_to_karakeep","last_synced_at":"2025-07-02T15:06:34.004Z","repository":{"id":294697214,"uuid":"985784159","full_name":"thiswillbeyourgithub/freshrss_to_karakeep","owner":"thiswillbeyourgithub","description":"A Python tool to transfer saved/favorited items from FreshRSS to Karakeep with tagging and filtering capabilities.","archived":false,"fork":false,"pushed_at":"2025-06-04T20:11:54.000Z","size":11,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-04T22:58:02.840Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thiswillbeyourgithub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-05-18T14:20:13.000Z","updated_at":"2025-06-04T20:11:55.000Z","dependencies_parsed_at":"2025-05-21T16:51:02.109Z","dependency_job_id":"c2fd5bb1-cfe9-4bb4-a1f4-cc885780ab27","html_url":"https://github.com/thiswillbeyourgithub/freshrss_to_karakeep","commit_stats":null,"previous_names":["thiswillbeyourgithub/freshrss_to_karakeep"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thiswillbeyourgithub/freshrss_to_karakeep","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiswillbeyourgithub%2Ffreshrss_to_karakeep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiswillbeyourgithub%2Ffreshrss_to_karakeep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiswillbeyourgithub%2Ffreshrss_to_karakeep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiswillbeyourgithub%2Ffreshrss_to_karakeep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thiswillbeyourgithub","download_url":"https://codeload.github.com/thiswillbeyourgithub/freshrss_to_karakeep/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiswillbeyourgithub%2Ffreshrss_to_karakeep/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263163163,"owners_count":23423495,"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":"2025-07-02T15:06:32.029Z","updated_at":"2025-07-02T15:06:33.997Z","avatar_url":"https://github.com/thiswillbeyourgithub.png","language":"Python","readme":"# FreshRSS to Karakeep\n\nA tool to transfer saved/favorited items from [FreshRSS](https://github.com/FreshRSS/FreshRSS) to [Karakeep](https://github.com/karakeep-app/karakeep).\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n## Overview\n\nFreshRSS to Karakeep simplifies the curation workflow between self-hosted FreshRSS (RSS reader) and Karakeep (bookmarking/read-it-later app). The tool automatically transfers items you've marked as \"favorites\" (saved) in FreshRSS to your Karakeep instance, applying the \"freshrss\" tag for easy identification.\n\n## Workflow\n\nThe intended workflow is simple:\n\n1. Browse your RSS feeds in FreshRSS\n2. Mark interesting items as \"favourite\" (which is called 'saved' in the Fever API)\n3. Have a scheduled job (e.g., systemd timer) run this script daily\n4. Find your saved items in Karakeep with the \"freshrss\" tag\n\n## Dependencies\n\nThis tool relies on two custom API clients that I made:\n- [karakeep_python_api](https://github.com/thiswillbeyourgithub/karakeep_python_api/)\n- [freshrss_python_api](https://github.com/thiswillbeyourgithub/freshrss_python_api/)\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/freshrss-to-karakeep.git\ncd freshrss-to-karakeep\n\n# Install dependencies\npip install -r requirements.txt\n```\n\n## Configuration\n\nYou need to set the following environment variables:\n\n### FreshRSS Configuration\n```bash\nexport FRESHRSS_PYTHON_API_HOST=\"https://your-freshrss-instance.com\"\nexport FRESHRSS_PYTHON_API_USERNAME=\"your_username\"\nexport FRESHRSS_PYTHON_API_PASSWORD=\"your_password\"\n```\n\n### Karakeep Configuration\n```bash\nexport KARAKEEP_PYTHON_API_ENDPOINT=\"https://your-karakeep-instance.com/api/v1\"\nexport KARAKEEP_PYTHON_API_KEY=\"your_api_key\"\nexport KARAKEEP_PYTHON_API_VERBOSE=\"true\"  # Optional\nexport KARAKEEP_PYTHON_API_VERIFY_SSL=\"true\"  # Optional, defaults to true\n```\n\n### Logging Configuration\nThe application always logs at DEBUG level to a log file, but console output verbosity can be controlled with the `--verbose` flag.\n\n## Usage\n\n```bash\n# Basic usage\npython freshrss_to_karakeep.py\n\n# Only include items with URLs matching a pattern\npython freshrss_to_karakeep.py --needed-regex \"github\\.com\"\n\n# Exclude items with URLs matching a pattern\npython freshrss_to_karakeep.py --ignore-regex \"youtube\\.com\"\n\n# Dry run (don't actually transfer, just show what would be transferred)\npython freshrss_to_karakeep.py --dry-run\n\n# Keep items saved in FreshRSS after transfer\npython freshrss_to_karakeep.py --no-unsave-freshrss\n```\n\n### Command-line Arguments\n\n| Argument | Description | Default |\n|----------|-------------|---------|\n| `--needed-regex` | Only include items with URLs matching this regex | `.*` (all URLs) |\n| `--ignore-regex` | Exclude items with URLs matching this regex | `\"\"` (none) |\n| `--dry-run` | Don't actually transfer items, just show what would be transferred | `False` |\n| `--unsave-freshrss/--no-unsave-freshrss` | Whether to unsave items from FreshRSS after transfer | `True` |\n| `--verbose` | Show detailed log messages in console output | `False` |\n\n## Automation with systemd\n\nTo run this script daily, you can set up a systemd service and timer:\n\n1. Create a service file at `/etc/systemd/system/freshrss-to-karakeep.service`:\n```ini\n[Unit]\nDescription=Transfer saved items from FreshRSS to Karakeep\nAfter=network.target\n\n[Service]\nType=oneshot\nExecStart=/usr/bin/python3 /path/to/freshrss_to_karakeep.py\nEnvironment=\"FRESHRSS_PYTHON_API_HOST=https://your-freshrss-instance.com\"\nEnvironment=\"FRESHRSS_PYTHON_API_USERNAME=your_username\"\nEnvironment=\"FRESHRSS_PYTHON_API_PASSWORD=your_password\" \nEnvironment=\"KARAKEEP_PYTHON_API_ENDPOINT=https://your-karakeep-instance.com/api/v1/\"\nEnvironment=\"KARAKEEP_PYTHON_API_KEY=your_api_key\"\n# No environment variable for logging needed anymore\nWorkingDirectory=/path/to/directory\n\n[Install]\nWantedBy=multi-user.target\n```\n\n2. Create a timer file at `/etc/systemd/system/freshrss-to-karakeep.timer`:\n```ini\n[Unit]\nDescription=Run FreshRSS to Karakeep transfer daily\n\n[Timer]\nOnCalendar=daily\nPersistent=true\n\n[Install]\nWantedBy=timers.target\n```\n\n3. Enable and start the timer:\n```bash\nsudo systemctl enable freshrss-to-karakeep.timer\nsudo systemctl start freshrss-to-karakeep.timer\n```\n\n## License\n\nThis project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.\n\n---\n*This README was created with assistance from [aider.chat](https://github.com/Aider-AI/aider/)*\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiswillbeyourgithub%2Ffreshrss_to_karakeep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthiswillbeyourgithub%2Ffreshrss_to_karakeep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiswillbeyourgithub%2Ffreshrss_to_karakeep/lists"}