Sync Notion with Paperpile
Project description
Paperpile Notion Integration
NOTE: This is a not an official Paperpile integration.
This is a Python CLI to manually sync your articles in Paperpile to a Notion database. Optionally, you may sync an authors database as well.
NOTE: This will only be maintained if Paperpile doesn't integrate directly with Notion. They have expressed interest, here.
This is a :construction: work in progress. This isn't production-ready software, so it may be contain edge-cases not present in the BibTeX's we have tested. Please feel free to open issues if you encounter any bugs.
Usage
The documentation site contains a thorough walk-through to setup a GitHub-based sync service which just requires some initial configuration.
Installation
You can pip
install paperpile-notion
, preferably in a virtual environment.
pip install paperpile-notion
Requirements
To use paperpile-notion
, you'll need a few things:
- A
JSON
export from Paperpile. You can retrieve this by going to "Settings > Export > Export to JSON". - A configuration file, similar to what you'll find in
docs/config.yml
. Currently, we do not support venues, but it is planned. - Your
Article
database URL, which you can copy directly from your browser. - (optional) Your
Author
database URL, copied in a similar way as above. - Your
token_v2
(detailed below) OR your email/password (never stored bypaperpile-notion
).
NOTE: Your Article
database must have the following columns:
Name | Type | Description |
---|---|---|
ID | text |
An ID issued by Paperpile which can be used to uniquely identify papers, feel free to hide the column in Notion once created. |
Status | select |
Your reading status. Can be fully customized in your config.yml . |
Authors | multi_select OR relation |
The paper's authors. If you have an Author database, use the relation type otherwise a multi_select . |
URL | url |
A link to the paper in Paperpile. |
Fields | multi_select |
The [sub-]fields the paper belongs to. |
Methods | multi_select |
The methods/tools used in the paper. |
Usage
As we use notion-py
, we are limited by their support for either an
email/password login OR your TOKEN_V2
. Your token_v2
may be retrieved from
your [notion.so][notion] cookies.
Using your token_v2
(recommended)
You have two ways to supply your token_v2
to paperpile-notion
:
- (preferred) You may store it in an environment variable called
NOTION_TOKEN_V2
, which will be read bypaperpile-notion
. - OR you may pass your token in using the
--token <token_v2>
flag.
# Using NOTION_TOKEN_V2
$ paperpile-notion update-db --refs <YOUR_JSON>.json
# Using --token ...
$ paperpile-notion --token <token_v2> update-db --refs <YOUR_JSON>.json
Using your email/password
You will be prompted each time for your Notion email/password login.
paperpile-notion update-db --refs <YOUR_JSON>.json
Example output
When adding, adding a new paper to the database:
Example resulting database on Notion:
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
Built Distribution
File details
Details for the file paperpile-notion-0.3.5.tar.gz
.
File metadata
- Download URL: paperpile-notion-0.3.5.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.8.6 Darwin/20.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67f3be1f81c13c9115c15b8539cd4233cfb8a56030f04f32f599ba7b8822c721 |
|
MD5 | 088fcb7a3161bb57eac6335e955ede33 |
|
BLAKE2b-256 | eaf6da131d2cafe5de9be5bccf6fb3042cbee3349b6970986e8602e84672a02f |
File details
Details for the file paperpile_notion-0.3.5-py3-none-any.whl
.
File metadata
- Download URL: paperpile_notion-0.3.5-py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.8.6 Darwin/20.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7db1498f1ff372894083e652aa6833a5e2d9a3a9b6ece129c9025f1650e3771 |
|
MD5 | 969ef5429c69216cdc0c83c54abee09b |
|
BLAKE2b-256 | 5cf5244bf617923490ed11a0db0ea0ddb79c1ff10d938c9a1ae6c93037ecf1df |