hep-paper-manager 0.4.0

A command-line app helps add High Energy Physics (HEP) papers to a Notion database.

HEP Paper Manager (HPM)

HPM is a command-line tool that helps add papers from Inspire HEP to Notion database according to its ArXiv ID.

Features:

• Retrieve papers by arXiv ID.
• Customizable paper template.
• Interactive CLI for easy setup and usage.

Installation

pip install hep-paper-manager

Try to add a paper to a demo database

Before we start, please make sure you have installed this app successfully.

In this step-by-step guide, we will together add "[1511.05190] Jet image -- deep learning edition"(link) to a demo database.

Step 1: Create an integration in Notion

1. Open My Integrations.
2. Click + New integration.
3. Enter a name for your integration.
4. Select your workspace.
5. Click show and copy the integration secret as your token.

To learn more about integrations, please check the official guide here.

Step 2: Create a blank page and link the integration to it

1. Click the + button next to your workspace name to create a new blank page.
2. In the three-dot menu in the upper right, find Connect to.
3. Select the integration you created in the previous step.

Step 3: Create a demo database via hpm

Open your terminal, and input:

hpm demo -t <token> -p <page_id>

You should see a database is created and connected to the integration.

Step 4: Initialize the hpm app

Use the token to initialize the hpm app.

hpm init -t <token>

Step 5: Add the paper to the database

Use hpm add to add it into the demo database.

hpm add 1511.05190

Go back and check the database page. The paper is right there!

Try to add more papers as you like!

Modify the default paper template

You can use hpm info to find the app directory. The default paper template is located at {app_dir}/templates/paper.yml:

database_id: <your database_id>
properties:
  id: null
  url: URL
  type: null
  source: null
  title: Title
  authors.name: Authors
  created_date: Date
  published_place: Published in
  published_date: Published
  eprint: ArXiv ID
  citation_count: Citations
  abstract: Abstract
  doi: DOI
  bibtex: BibTeX

The keys in the properties section are the paper information retrieved from Inspire HEP. Their values correspond to the Notion page properties. Modify them as you like. null means that information will not be recorded in the database.

Other commands

• hpm update [<arxiv_id>|all]: Update one paper according to its ArXiv ID or all papers in the database.

• hpm info: Show all file paths related to this app.
• hpm clean: Remove all files related to this app.

Updates

v0.4.0

• Refactor the codebase and reorganize the file structure.

v0.3.0

• Refactor the codebase by only allowing adding papers by arXiv ID.

v0.2.2

• Fix the error when hpm add some conference papers that may have no publication info.

v0.2.1

• Fix the bug that hpm add only checks the first 100 pages in the database.
• Fix the checkmark style.

v0.2.0

• Refactor the codebase by introducing notion_database.
• Add hpm update to update one paper in the database.
• Add hpm info to show the information of this app.

v0.1.4

• Update print style.
• Add friendly error message when the database_id is not specified.

v0.1.3

• Update hpm add to check if the paper already exists in the database.
• You can now create a database with more properties then the template.

v0.1.2

• Update paper from Inspire engine to include url, bibtex, and source.

v0.1.1

• Add hpm init for interactive setup.
• Add hpm add for adding a paper to a Notion database.
• Introduce the default Inspire engine and paper.yml template.