hep-paper-manager 0.1.1

HPM is a command-line tool that adds High Energy Physics (HEP) papers to a Notion database.

HEP Paper Manager (HPM)

HPM is a command-line tool that adds High Energy Physics (HEP) papers to a Notion database. It leverages the Inspire engine to source these academic papers, creating a streamlined process for HEP researchers.

Features

• Fetch HEP papers via the Inspire engine.
• Directly add fetched papers to your Notion database.
• Interactive CLI for easy setup and usage.

Installation

pip install hep-paper-manager

Usage

Before using hpm, check this link to create an integration with the Notion API to let hpm work with your database.

1. Use hpm init to set up HPM:

   hpm init
   

   During this process, you will be asked to input your Notion API key and choose a paper template. You'll also be shown related directories where you can modify the default paper template or introduce your own templates.
2. Use hpm add to fetch and add a paper to your Notion database:

   hpm add <template> <parameter>
   

   <parameter> is a comma-separated string like "param1,param2" to pass to the get method of the chosen engine. For the default Inspire engine, it refers to the arxiv ID of the paper.

Example: Add "[1511.05190] Jet image -- deep learning edition" to a Notion database

1. First create a database in Notion:

   Arxiv ID: Text
   Citations: Number
   Title: Title
   Journal: Select
   Authors: Multi-select
   Abstract: Text
   

   Tip: Consider adding Authors as a Relation property. This allows you to concentrate on specific authors or professors of interest. Just add the integration to the related professors' database. hpm will locate authors based on the page Title property in the related database and fetched names.

2. Then set up hpm with hpm init:

3. Before adding our paper to a database, review the default paper.yml template and insert the database ID: The database ID is in the database URL. For the database just created: "https://www.notion.so/star9daisy/67877176f7064ed982e177aaf70f27cb?v=ffcad911d3d9416bb91657814242fd27&pvs=4", "67877176f7064ed982e177aaf70f27cb" is the database ID.

   Remember to structure your database as shown above and add the integration to the database!

4. Now let's add the paper into the database: The database in Notion should now look like the following:

Engines

• Inspire: It fetches papers from the Inspire HEP. It serves the default engine for hpm.
  • Parameters: arxiv_id
  • Returns: Paper(title, authors, abstract, journal, citations)

Templates

You can adjust the properties within the template. On the left is the returned value from the engine and on the right is the property name in the Notion database.

• paper.yml

  engine: Inspire
  database: <database_id>
  properties:
    arxiv_id: Arxiv ID
    citations: Citations
    title: Title
    journal: Journal
    authors: Authors
    abstract: Abstract
  

Updates

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.