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. Create a .env file with the following variables:

    NOTION_TOKEN=secret_XXXXXXXX
    NOTION_DATABASE_ID=XXXXXXXXXXXXXXXX
    

    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

Download

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

from rsrch import download
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.

from rsrch import upload
upload()

image

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

Popular

You can get the most popular papers from this day, week, or month from the LabML database.

from rsrch import popular
popular(sort_by="weekly", num_papers=10)

image

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.1.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

rsrch-0.2.1-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rsrch-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a6853f44615dca196cdc60645858aba9ad2dbe3855e5a5737f805bcfdd3a8d3c
MD5 30c0530a7c255201817e3b3ca664ca7c
BLAKE2b-256 75f50d965d28ed3b782994a54191505379f8d5eb178c928466b94ef4358f3cf7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rsrch-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 34cf97af757778dfe7c38b9c53a6c3680ed1815d90db5649ed91161f7b12d091
MD5 ba32b10ca6c9ebbf4172e80ad873273d
BLAKE2b-256 4aca40da3cb09fd27c97a69694587d08bf5388f1c095b4606b45d5064c6d1d49

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