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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: rsrch-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 f8e2d77f16a66d925f3de5acb1a18b65efa63c9001b1808bea7485c2b09ae9df
MD5 8477e391d37054c84ad3c088a2d40e36
BLAKE2b-256 16f6d184a1ac69afb84d9f5fd984a23d8fda6b3286c26daa3931cdc2ad0b6e51

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rsrch-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6f8b3b29c19fff77ce107ce79bbdb3faf937334a3102d91a9688746c821be723
MD5 8b87a2683b0a229503188b890554a790
BLAKE2b-256 3c6b705aa3557e3635d913aa90050e62c29545fa2f448f388d169881d43e9e7f

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