https://github.com/jacksalici/notion-cli-list-manager

A simple command-line tool for managing Notion databases.
https://github.com/jacksalici/notion-cli-list-manager

cli database notion python todo

Last synced: 2 months ago
JSON representation

A simple command-line tool for managing Notion databases.

• Host: GitHub
• URL: https://github.com/jacksalici/notion-cli-list-manager
• Owner: jacksalici
• License: mit
• Created: 2021-12-19T16:19:31.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-05T15:38:27.000Z (almost 3 years ago)
• Last Synced: 2024-04-10T07:34:02.206Z (9 months ago)
• Topics: cli, database, notion, python, todo
• Language: Python
• Homepage:
• Size: 8.27 MB
• Stars: 89
• Watchers: 2
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

##### ⚠️ This project is still in work in progress, please forgive any little flaw here and there.

# Notion CLI List Manager 🗂

A simple command-line tool for managing [Notion](http://notion.so) ___List___ databases. ✨  

### Increase your productivity with a simple command. 🛋

![](showcase.gif)

## 📺 Features:

- fast and clear; saving your idea is as simple as type `add "get money"` 💆‍♂️

- tables are pretty-printed with fab ASCII tables 🌈

- parameters are now supported [^3] 🎻

## 👾 Get Started:

- Create a new internal api integration [here](https://www.notion.so/my-integrations).

- ❗️ Share the default database you want to use with your integration.  

  You can copy [my free simple template](https://jacksalici.notion.site/d75c9590dc8b4d62a6c65cbf3fdd1dfb?v=0e3782222f014d7bb3e44a87376e3cfb).

- Download the tool: [^1]

```

    pip install notion-cli-list-manager

```

- Set the token and your default database id:

```

    list set --token [token] --id [database-id]

``` 

- You're done!

## 🧰 Syntax:

TL;DR: `list` is the keyword for activating this tool from the terminal. Typing just `list`, the list of your default database's items will be shown. Other commands can be used typing `list [command]`

| Commands:|    | Args and options:|

|---|---|---|

| `list` | to display all the ___List___ items. | `--db [id] ` to display a specific database. Otherwise the default database will be shown.
 `--all` to display all the lists.

| `list add [title]` | to add a new ___List___ item called `title`. |   `[title]` will be the text of the ___List___ item (and the title of the associated Notion database page)  
 `--db [id] ` to add the entry to a specific database. Otherwise, the default database will be used.| 

| `list rm [index]` | to remove the ___List___ item with the index `index`.  
 _(Command to call after `list`)_| `[index]` has to be formatted either like a range or a list, or a combination of these. E.g.: 3,4,6:10:2 will remove pages 3, 4, 6, 8.

| `list db` | to display all the notion display saved in the manager. | `--label [LABEL] --id [ID]` to add a database to the manager. A prompt will then ask you the ordered indexes list.
 `--rm [LABEL]` to remove a database named [LABEL] from the manager. Note that adding or removing a database to the manager does not cause the actual creation or deletion on Notion. 
 `--prop [LABEL]` to set which and in which order display the properties of an already saved database labeled [LABEL]. A prompt will then ask you the ordered indexes list[^3].

| `list set --token [token] --id [database_id]` | to set the token and the ID of the Notion Database you want as default. _This must be executed as the first command_. | You can get the `[token]` as internal api integration [here](https://www.notion.so/my-integrations). 
 You can get the database id from the database url: notion.so/[username]/`[database_id]`?v=[view_id]. 
 You can also use separately `--token` and `--id` to set just one parameter. After the `--id` command, a prompt will then ask you the ordered indexes list.   |

## 🛒 Still to do:

See the [project tab](https://github.com/jacksalici/notion-cli-list-manager/projects/1) for a complete and real-time-updated list.    

Issues and PRs are appreciated. 🤝

[^3]: At the present, properties are fully supported (except Relations and Rolls up that are __NS__ - Not supported) but read-only. Writeable ones will be supported in the next versions.

[^1]: You can also clone the repo to have always the very last version.  

Having installed Python3 and Pip3 on your machine, write on the terminal:  

`git clone https://github.com/jacksalici/notion-cli-list-manager.git notion-cli-list-manager`  

`pip3 install notion-cli-list-manager/dist/notion-cli-list-manager-[last-version].tar.gz`