{"id":20063740,"url":"https://github.com/geometric-intelligence/bioshape-bot","last_synced_at":"2025-03-02T10:27:40.964Z","repository":{"id":197864793,"uuid":"630960724","full_name":"geometric-intelligence/bioshape-bot","owner":"geometric-intelligence","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-21T15:06:15.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-12T22:43:00.324Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geometric-intelligence.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}},"created_at":"2023-04-21T15:04:17.000Z","updated_at":"2023-04-21T15:05:52.000Z","dependencies_parsed_at":"2023-10-03T04:41:07.832Z","dependency_job_id":null,"html_url":"https://github.com/geometric-intelligence/bioshape-bot","commit_stats":null,"previous_names":["geometric-intelligence/bioshape-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geometric-intelligence%2Fbioshape-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geometric-intelligence%2Fbioshape-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geometric-intelligence%2Fbioshape-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geometric-intelligence%2Fbioshape-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geometric-intelligence","download_url":"https://codeload.github.com/geometric-intelligence/bioshape-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241491656,"owners_count":19971530,"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-11-13T13:43:38.459Z","updated_at":"2025-03-02T10:27:40.943Z","avatar_url":"https://github.com/geometric-intelligence.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PapersBot\n\nPapersBot is an academic Twitter bot: it reads RSS feeds from journals and preprint archives, selects papers based on keyword matching, and tweets them.\n\nI ([@fxcoudert](https://twitter.com/fxcoudert)) wrote PapersBot to operate my [@MOF_papers](https://twitter.com/MOF_papers) twitter bot, which tweets papers about metal–organic frameworks and related nanoporous materials.\n\nPapersBot was inspired by (and borrows some code from) [feedr](https://github.com/housed/feedr).\n\n---\n\n## Requirements\n\nPython 3 and the following modules: [beautifulsoup4](https://pypi.org/project/beautifulsoup4/), [feedparser](https://github.com/kurtmckee/feedparser), [tweepy](https://github.com/tweepy/tweepy).\n\nIf you have Python 3 installed, you can install those modules with  `pip install bs4 feedparser tweepy`.\n\n## Setup\n\nIn order to run PapersBot, you need to do the following:\n- Create a file `credentials.yml` which will contain your Twitter app credentials, with four lines:\n```\nCONSUMER_KEY: \"x1F3s...\"\nCONSUMER_SECRET: \"3VNg...\"\nACCESS_KEY: \"7109...\"\nACCESS_SECRET: \"AdnA...\"\n```\nIf you do not know how to get your Twitter credentials, follow [steps #1 and #2 in this tutorial](https://www.digitalocean.com/community/tutorials/how-to-create-a-twitter-app) to register your app with Twitter and get credentials.\n- Adjust the file `feeds.txt` which contains the list of RSS feeds you want to crawl. Lines starting with `#` are ignored.\n- Inside the code, adjust the [regular expression](https://en.wikipedia.org/wiki/Regular_expression) that selects the papers of interest\n- Some extra parameters can be tweaked in configuration file `config.yml`.\n\n## How to run\n\nPapersBot tracks in a file named `posted.dat` (which it will create) the papers that have already been tweeted. The first time you run it, if there is no `posted.dat` from a prior run, PapersBot can thus post **a lot** of papers. If you want to avoid this, especially on the first run or if it hasn't been run for a long time, use the `--do-not-tweet` option.\n\n`papersbot.py --do-not-tweet` will list the papers it _would_ tweet, without actually tweeting. But papers will still be recorded as tweeted in the `posted.dat` file.\n\n## Other features\n\n- Running `papersbot.py --top-tweets` will give you a list of the 5 top tweets, from the bot's 200 latest tweets. It sorts tweets by adding number of retweets and likes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeometric-intelligence%2Fbioshape-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeometric-intelligence%2Fbioshape-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeometric-intelligence%2Fbioshape-bot/lists"}