{"id":24074855,"url":"https://github.com/lfl-lab/lfl_paperbot","last_synced_at":"2025-06-30T10:04:21.766Z","repository":{"id":215162119,"uuid":"738268248","full_name":"LFL-Lab/LFL_PaperBot","owner":"LFL-Lab","description":"Paperboy-LFL is an automated tool for monitoring academic publications. It searches RSS feeds for specified keywords and authors, then pushes matching articles in a readable format to a designated Slack channel. This automation is fully handled via GitHub Actions.","archived":false,"fork":false,"pushed_at":"2025-06-19T15:13:05.000Z","size":1409,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-19T16:27:38.846Z","etag":null,"topics":["academia","bot","rss","slack"],"latest_commit_sha":null,"homepage":"","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/LFL-Lab.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":"2024-01-02T20:46:00.000Z","updated_at":"2025-06-19T15:13:08.000Z","dependencies_parsed_at":"2025-04-17T15:37:38.967Z","dependency_job_id":"cec65286-2b3f-44b9-9725-7b1673cb00dc","html_url":"https://github.com/LFL-Lab/LFL_PaperBot","commit_stats":null,"previous_names":["lfl-lab/lfl_paperbot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LFL-Lab/LFL_PaperBot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2FLFL_PaperBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2FLFL_PaperBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2FLFL_PaperBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2FLFL_PaperBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LFL-Lab","download_url":"https://codeload.github.com/LFL-Lab/LFL_PaperBot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2FLFL_PaperBot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262753013,"owners_count":23358879,"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":["academia","bot","rss","slack"],"created_at":"2025-01-09T18:21:57.555Z","updated_at":"2025-06-30T10:04:21.743Z","avatar_url":"https://github.com/LFL-Lab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LFL PaperBot :robot:\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/LFL-Lab/LFL_PaperBot/CI)](https://github.com/LFL-Lab/LFL_PaperBot/actions)\n[![License](https://img.shields.io/github/license/LFL-Lab/LFL_PaperBot)](https://github.com/LFL-Lab/LFL_PaperBot/blob/main/LICENSE)\n\n## Overview\n\nLFL_PaperBot is an automated tool for monitoring academic publications. It searches RSS feeds for specified keywords and authors, then pushes matching articles in a readable format to a designated Slack channel. This automation is fully handled via GitHub Actions.\n\n## Getting Started\n\n### Prerequisites\n\n- A GitHub account\n- A Slack workspace with a bot user\n\n### Setup\n\n#### Slack Bot User\n\n1. Create an app in your Slack workspace by visiting [Slack API](https://api.slack.com/apps).\n2. Enable the Slack bot user.\n3. Install the app to your workspace and copy the bot user token from the 'OAuth \u0026 Permissions' tab.\n4. Add the bot user token as a secret in your GitHub repository (named `SLACK_TOKEN`).\n\n#### GitHub Repository\n\n1. Fork the LFL_PaperBot repository to your GitHub account.\n2. Clone the forked repository to your local machine for configuration.\n\n#### Configuration Files\n\n- `authors.txt`: List authors to track. Include variations of names with/without middle initials.\n- `feeds.txt`: URLs of RSS feeds to monitor.\n- `keywords.txt`: Keywords to search within the articles.\n- `channel.txt`: Slack channel ID where the articles will be posted.\n\n#### Updating Configuration Files\n\n1. Modify `authors.txt`, `feeds.txt`, `keywords.txt`, and `channel.txt` as needed in your forked repository.\n2. Commit and push the changes to your GitHub repository.\n\n### GitHub Actions\n\n- The workflow is set up in `.github/workflows/schedule.yml`.\n- The action is scheduled to run at a specified time every day.\n- On execution, the script `distributor.py` processes the RSS feeds and sends the relevant articles to the specified Slack channel.\n\n**Updates needed for the GitHub Actions workflow:**\n\n- Ensure that \"Read and write permissions\" are enabled in Settings -\u003e Actions -\u003e General -\u003e Workflow permissions\n- Update the schedule in `schedule.yml` to the desired time.\n- Update the `SLACK_TOKEN` secret in the repository settings if the bot user token changes.\n- Create a repository secrets variable (`GH_PAT`) with value that is your `PAT_NAME` that has at least the `repo` scope enabled.\n  - _If you don't have a PAT_: Go to your GitHub settings, then to Developer settings \u003e Personal access tokens \u003e Generate new token. Make sure the token has the `repo` scope.\n- Update the `GIT_HTTPS_USERNAME` to your username\n\n## Contributing\n\nTo add more keywords, feeds, or authors:\n\n1. Fork the repository.\n2. Modify `keywords.txt`, `feeds.txt`, or `authors.txt` as needed.\n3. Commit and push your changes to your forked repository.\n4. Create a pull request for your changes to be reviewed and merged into the main repository.\n\n## Important Notes\n\n- Avoid overwhelming your Slack channel with repeated messages during initial setup and testing. Consider using a private channel for testing.\n- Follow best practices when making contributions to the project via pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfl-lab%2Flfl_paperbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flfl-lab%2Flfl_paperbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfl-lab%2Flfl_paperbot/lists"}