floriaaan / notion-task-reporter

NotionTR (Notion Task Reporter) is an utility that easily allows you to generate a reporting of your tasks in Notion.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License

About The Project

NotionTR (Notion Task Reporter) is an utility that easily allows you to generate a reporting of your tasks in Notion.

The project was created to help me generate a weekly report of my tasks in Notion, but it can be used for any other purpose. It can be used with any Notion input database, as long as it has the following properties:

• a name property: a text property with the name of the task,
• a assigné property: a multi-select property with the users assigned to the task,
• a date property: a date property with the date of the task (from-to supported),
• a projet property: a select property with the project of the task (used to group tasks by project),
• a état property: a select property with the status of the task (used to filter tasks by status),
• a content: the content of the task (optional, used to describe the task).

We will provide a template database in the future, and a way to customize the properties.

---

Features

NotionTR is a CLI tool, designed to be used with a cron job. It can generate a report in two formats:

• markdown (returns Notion blocks),

• ai (with OpenAI's autocomplete, returns Notion paragraph).

---

Built With

• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/floriaaan/notion-task-reporter.git

2. Install NPM packages

   npm install # yarn install, pnpm install

3. Provide your environnement variables (optional if passing them as arguments)

   cp .env.example .env

   Then fill the .env file with your Notion API Token and input/output database ids.

Usage

• Launch NotionTR : pnpm start
• Launch NotionTR with arguments : pnpm start --type=(ai|markdown)
• Show supported parameters : pnpm start --help

(back to top)

Roadmap

• Add complete support for environments variables as arguments
• Add support for multiple databases in input
• Add workflow to build and release binaries for all platforms
• Add support for other output formats (JSON, CSV, etc.)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'feat: add amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

License

Currently, this project has no license. Feel free to use it as you want.

(back to top)