Skip to main content

Manage your ever-growing list of research papers

Project description

rsrch

Manage your research papers from Python. This project lets you update a Notion database with arXiv links and download PDFs of papers to your local machine.

image

Installation

  1. Create an internal integration in Notion.

  2. Add the integration to the database you want to download from.

  3. Store your NOTION_TOKEN and NOTION_DATABASE_ID somewhere safe. Your NOTION_TOKEN can be found in your integrations page and is called the Internal Integration Token. The NOTION_DATABASE_ID can be found in the URL of your database (https://www.notion.so/{workspace_name}/{database_id}?v={view_id}).

  4. Install local dependencies:

    pip install rsrch
    
  5. Important: Your Notion database must have the following columns with the corresponding types:

    • Title: Title
    • URL: URL
    • Date: Date
    • Authors: Text

    You can add more columns, but these are the ones that are required.

Usage

Setup

from rsrch import RsrchClient

client = RsrchClient(
    token=NOTION_TOKEN,
    database_id=NOTION_DATABASE_ID,
)

Download

This will download all the papers from your Notion database to the papers/ directory.

client.download()

image

Upload

You can upload arXiv abstract links, PDF links, or IDs to your Notion database and have it autofill all of the relevant fields.

client.upload(
    arxiv_urls=[
        "https://arxiv.org/abs/1706.03762",
        "https://arxiv.org/pdf/1706.03762.pdf",
        "1706.03762",
    ]
)

image

Alternatively, you can add non-arXiv links manually to Notion.

Notes

  • Uploading papers to Notion is currently only supported for arXiv links. Papers with titles that already exist in the database will not be uploaded.
  • I plan on adding support for other databases in the future, but for now it only works with Notion databases.
  • To build and release this:
    • Make new code accessible in src/__init__.py
    • Update the version in src/__about__.py
    • Run python3 -m build
    • Run python3 -m twine upload dist/*

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rsrch-0.2.3.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

rsrch-0.2.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file rsrch-0.2.3.tar.gz.

File metadata

  • Download URL: rsrch-0.2.3.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for rsrch-0.2.3.tar.gz
Algorithm Hash digest
SHA256 96197e69b3394d6ce6229297dc7714ce623264d94af0a0fbede63d08b5d9abad
MD5 5528e6e90e8e08688763fa726cbc36cb
BLAKE2b-256 3bd9484bf3b863ba033e622dd92a0bba8126e31e144a8834496e6ceff9d63930

See more details on using hashes here.

File details

Details for the file rsrch-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: rsrch-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for rsrch-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b794645cc9695bf1abbf48caa255b6da9105eda20f52ea68d2654f1c07c7badd
MD5 20ee59909498673deb3216934d263a9f
BLAKE2b-256 35b96c75f1f65563d20c09dd97e9a8ef18a403d2d702844c808e1ad49263274a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page