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.5.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

rsrch-0.2.5-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rsrch-0.2.5.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for rsrch-0.2.5.tar.gz
Algorithm Hash digest
SHA256 4b442d068ce2575114e7b683693a1f217f9d57acbc7151cff4060f8b5621f318
MD5 b83ada47496a5bc7c2cd85ec474baaa3
BLAKE2b-256 bcc7c8e8d562372d24baac3f0c6f3384e507861b21ec09c62f2c883ee180318e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rsrch-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a36a8794edc603d995fc135ce4d8775da036de8a726cd016d3245f6d243b162b
MD5 648ace6f2ccda9167e6347debfd77028
BLAKE2b-256 ad94a3167440d4f07122818dcca0333db7d73452a93d7fd12f59e936d8b07321

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