{"id":29821889,"url":"https://github.com/nagasaki45/rss-pipes","last_synced_at":"2025-07-29T00:13:02.202Z","repository":{"id":295157269,"uuid":"989345197","full_name":"Nagasaki45/rss-pipes","owner":"Nagasaki45","description":"Composable RSS feeds utilities, inspired by unix pipes","archived":false,"fork":false,"pushed_at":"2025-05-23T23:15:05.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-24T00:24:00.711Z","etag":null,"topics":["atom","feeds","rss"],"latest_commit_sha":null,"homepage":"https://rss-pipes.leverstone.me","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nagasaki45.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,"zenodo":null}},"created_at":"2025-05-23T23:13:09.000Z","updated_at":"2025-05-23T23:16:12.000Z","dependencies_parsed_at":"2025-05-24T00:24:09.880Z","dependency_job_id":"3c0db348-e0df-4308-a54f-5fbfd3c0659e","html_url":"https://github.com/Nagasaki45/rss-pipes","commit_stats":null,"previous_names":["nagasaki45/rss-pipes"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Nagasaki45/rss-pipes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nagasaki45%2Frss-pipes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nagasaki45%2Frss-pipes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nagasaki45%2Frss-pipes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nagasaki45%2Frss-pipes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nagasaki45","download_url":"https://codeload.github.com/Nagasaki45/rss-pipes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nagasaki45%2Frss-pipes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267607212,"owners_count":24114861,"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-07-28T02:00:09.689Z","response_time":68,"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":["atom","feeds","rss"],"created_at":"2025-07-29T00:13:01.717Z","updated_at":"2025-07-29T00:13:02.195Z","avatar_url":"https://github.com/Nagasaki45.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RSS-Pipes\n\nComposable RSS feed utilities inspired by Unix pipes. RSS-Pipes lets you transform, aggregate and filter RSS/Atom feeds via simple RESTful endpoints—so you can build custom digests or connect multiple tools in a pipeline.\n\n---\n\n## Features\n\n- **Digest Generation**\n  Aggregate feed entries into daily, weekly, or monthly digests.\n\n- **Flexible Scheduling**\n  Use human-readable schedule strings (`daily-HH:MM`, `weekly-{mon|tue|…|sun}-HH:MM`, `monthly-{day}-HH:MM`).\n\n- **Composable**\n  Pipe one endpoint's URL into another (e.g. digest → summarise).\n\n---\n\n## Quickstart\n\n### Requirements\n\n- Python 3.13 or later\n- [uv](https://pypi.org/project/uv/) (development runner)\n\n### Installation\n\n```bash\ngit clone https://github.com/your-org/rss-pipes.git\ncd rss-pipes\nuv install\n```\n\n### Run the API\n\n```bash\nuv run fastapi dev rss_pipes/main.py\n```\n\nThe service will start on `http://localhost:8000`.\n\n---\n\n## Usage\n\n### Digest Endpoint\n\nGenerate an Atom digest by hitting the `/digest/{feed_url}` endpoint:\n\n```\nGET /digest/{feed_url:path}?schedule={schedule}\n```\n\n- **feed_url**: URL to an RSS/Atom feed\n- **schedule**: schedule string, e.g.:\n  - `daily-09:00`\n  - `weekly-sat-10:00`\n  - `monthly-15-09:00`\n\nExample:\n\n```bash\ncurl \\\n  --get \\\n  --data-urlencode \"schedule=weekly-sat-10:00\" \\\n  http://127.0.0.1:8000/digest/https://leverstone.me/blog/atom.xml\n```\n\n**Response**: A new feed, digested following the provided schedule.\n\n### Schedule Format\n\n| Type    | Syntax                | Description                           |\n| ------- | --------------------- | ------------------------------------- |\n| Daily   | `daily-HH:MM`         | Every day at hour:minute             |\n| Weekly  | `weekly-\u003cday\u003e-HH:MM`  | Every week on `\u003cday\u003e` at time        |\n| Monthly | `monthly-\u003cday\u003e-HH:MM` | Every month on day `\u003cday\u003e` at time   |\n\nValid days for weekly: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`.\n\nValid days for monthly: `1` to `31`. For months shorter than the specified day, the occurrence will be on the last day of that month.\n\n---\n\n## Deployment\n\n### Dokku Deployment\n\nThis project is configured for deployment to Dokku instances:\n\n1. **Add your Dokku remote**:\n   ```bash\n   git remote add dokku dokku@your-server:rss-pipes\n   ```\n\n2. **Deploy**:\n   ```bash\n   git push dokku main\n   ```\n\nDokku will automatically detect the Dockerfile and deploy the application.\n\n---\n\n## Development\n\nWe use [uv](https://pypi.org/project/uv/) as a task runner:\n\n- **Run tests**\n  `uv run python -m pytest`\n\n- **Lint**\n  `uv run ruff check`\n  `uv run ruff format --check`\n\n- **Autoformat**\n  `uv run ruff format`\n  `uv run ruff check --fix`\n\n- **Type check**\n  `uv run mypy .`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnagasaki45%2Frss-pipes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnagasaki45%2Frss-pipes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnagasaki45%2Frss-pipes/lists"}