Notion class notes/study template automated using a CLI to seamlessly integrate scientifically proven study techniques with minimal friction.
['education', 'hacktoberfest', 'notion', 'notion-api', 'notion-template', 'study']
Notion class notes/study template automated using a CLI to seamlessly integrate scientifically proven study techniques with minimal friction.
<a name="readme-top"></a>
<!-- PROJECT LOGO -->
<br>
<div align="center">
  <a href="https://github.com/SenaThenu/StudySphere">
    <img src="https://github.com/SenaThenu/StudySphere/blob/main/readme-assets/logo.png" alt="Logo" height="125">
  </a>
<h3 align="center"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Rocket.png" alt="Rocket" width="25" height="25" /> StudySphere <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Rocket.png" alt="Rocket" width="25" height="25" /></h3>
  <p align="center">
    <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="25" height="25" /> Streamline your study journey with this open-source Notion template, integrating scientifically-backed techniques for maximum effectiveness. <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="25" height="25" />
    <br>
    <a href="https://github.com/SenaThenu/StudySphere/issues">Report a Bug <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Animals/Bug.png" alt="Bug" width="20" height="20" /> or Request a New Feature<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Star.png" alt="Star" width="20" height="20" /></a>
  </p>
</div>
<!-- PROJECT SHIELDS -->
<p align="center">
  <img src="https://img.shields.io/badge/license-MIT-blue.svg?labelColor=003694&color=ffffff" alt="License">
  <img src="https://img.shields.io/github/contributors/SenaThenu/StudySphere?labelColor=003694&color=ffffff" alt="GitHub contributors" >
  <img src="https://img.shields.io/badge/version-1.0.0-yellow.svg?labelColor=003694&color=ffffff" alt="Version">
  <img src="https://img.shields.io/github/stars/SenaThenu/StudySphere.svg?labelColor=003694&color=ffffff" alt="Stars">
  <img src="https://img.shields.io/github/forks/SenaThenu/StudySphere.svg?labelColor=003694&color=ffffff" alt="Forks">
  <img src="https://img.shields.io/github/issues/SenaThenu/StudySphere.svg?labelColor=003694&color=ffffff" alt="Issues">
</p>
<!-- Access to the Notion Template -->
<p align="center">
  <a href="https://senathenu.notion.site/2428547d9c0f45c48fa0b4018fec3e54?v=92e0d0c8a4c44bd7ba1acd1d67b7b1d0&pvs=4">
      <img src="https://img.shields.io/badge/Duplicate-The_Notion_Template-b8c7d6?&logo=notion&labelColor=003694&color=ffffff" alt="Download StudySphere Template">
  </a>
</p>
<!-- TABLE OF CONTENTS -->
## Table of Contents <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Scroll.png" alt="Scroll" width="25" height="25" />
-   [About The Project <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Open Book.png" alt="Open Book" width="20" height="20" />](#about-the-project-)
    -   [Built With <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Wrench.png" alt="Wrench" width="20" height="20" />](#built-with-)
-   [Getting Started <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Vertical Traffic Light.png" alt="Traffic Lights" width="20" height="20" />](#getting-started-)
    -   [Prerequisites <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Clipboard.png" alt="Clipboard" width="20" height="20" />](#prerequisites-)
-   [Usage <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Rocket.png" alt="Rocket" width="20" height="20" />](#usage-)
    -   [How the Template Works](#how-the-template-works)
    -   [How the Program Works](#how-the-program-works)
-   [Roadmap <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/World%20Map.png" alt="Map" width="20" height="20" />](#roadmap-️)
-   [Contributing <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Waving%20Hand.png" alt="Waving Hand" width="20" height="20" />](#contributing-)
-   [Current Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People/Man%20Mage.png" alt="Man Mage" width="20" height="20" />](#current-contributors-️)
-   [Contact <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/E-Mail.png" alt="E-Mail" width="20" height="20" />](#contact-)
-   [Acknowledgments \w <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Sparkling%20Heart.png" alt="Sparkling Heart" width="20" height="20" />](#acknowledgments-w-)
<!-- ABOUT THE PROJECT -->
## About The Project <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Open Book.png" alt="Open Book" width="25" height="25" />
<img src="readme-assets/preview.png" align="center"/>
Elevate your study game with this open-source Notion template—it's like having a personal study cheerleader! This template embraces the science-backed power of Active Recall and Spaced Repetition, all while adding a dash of fun with a traffic light system that guides your way.
The best part? Our trusty `manager.py` script automates the whole process kicking your friction in the butt! It's all about working smart, not hard, in this nonprofit study revolution!
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
### Built With <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Wrench.png" alt="Wrench" width="25" height="25" />
<a href="https://www.python.org/">
  <img src="https://img.shields.io/badge/Python-3570a0?style=for-the-badge&logo=python&logoColor=ffffff" alt="Python">
</a>
<a href="https://www.notion.so/">
  <img src="https://img.shields.io/badge/Notion_API-b8c7d6?style=for-the-badge&logo=notion&logoColor=000" alt="Notion API">
</a>
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
<!-- GETTING STARTED -->
## Getting Started <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Vertical Traffic Light.png" alt="Traffic Lights" width="25" height="25" />
To get started, download the code using any of the methods as shown below. (To get this, click on "Code" on the top-right)
<div align="center">
  <img src="https://github.com/SenaThenu/StudySphere/blob/main/readme-assets/download-the-code.png" alt="Download the Code" height="300">
</div>
### Prerequisites <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Clipboard.png" alt="Clipboard" width="25" height="25" />
1.  You have to duplicate the StudySphere Notion Template (unless you wanna create one from scratch :) Download it by following this [link](https://senathenu.notion.site/2428547d9c0f45c48fa0b4018fec3e54?v=92e0d0c8a4c44bd7ba1acd1d67b7b1d0&pvs=4)!
2.  Make sure Python is installed on your computer! You can install it via [Python Official Website](https://www.python.org/)!
3.  Afterwards, to run the trusty `manager.py` program, you need to install some third-party packages. So, open the terminal in the folder where you have the downloaded code. Then run,
        `pip install -r requirements.txt`
Then, follow the instructions of the following video...
https://github.com/SenaThenu/StudySphere/assets/98274844/ba3ff31b-cd75-4348-a456-2fa6089cdecb
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
<!-- USAGE EXAMPLES -->
## Usage <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Rocket.png" alt="Rocket" width="25" height="25" />
### How the Template Works
Basically, it's a database where you can store your class/lecture notes divided into main subjects/topics (or whatever you wanna call them). To keep things simple, we call them branches!
Every note you store in the StudySphere is associated with 3 Repetition Interval Columns (Rep 1, Rep 2, Rep 3) for you to store spaced repetition dates and 3 Repetition Rates columns to rate how confident you felt (green, yellow, red).
> Of course, you can add more... Just make sure to update the settings!
Based on your ratings, your strength is calculated regarding the content in that note. So, all the notes are sorted according to the strength. 
Then, there is a Revision Rep Column to perform revision on the notes when you have an exam ahead.
### How the Program Works
Instead of letting you manually set spaced repetition and revision dates (which is dreadful), it automatically sets them.
_Note: this is just what it is capable of currently..._
Yet, as a community, especially during this Hacktoberfest, we can extend it further. We all (including you) power up this! So, why are you waiting? Go ahead... It's okay to make mistakes. We all are learning _forever!_
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
#### User Settings
| Setting | Description | Default |
| ------- | :-: | :---: |
| API_KEY |  Your API Key. Watch the above video for help! | Nothing :O |
| StudySphere_ID | The Database ID of the StudySphere. | Nothing :O |
| Instructions | Whether instructions should be displayed or not. | True |
| Rep_Col_Names | A name list of all columns which store spaced repetition dates. | Rep 1, Rep 2, Rep 3 |
| Rep_Intervals | A list of Spaced Repetition intervals in days. | 7, 21, 60 |
| Notes_Title_Col_Name | The column name which stores the names of notes stored in a branch! | Lesson |
| Revision_Col_Name | Name of the column which stores revision dates! | Revise Rep |
> [!Note]
> You don't have to deal with Col_Names as long as you stick to the template :)
<!-- ROADMAP -->
## Roadmap <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/World%20Map.png" alt="World Map" width="25" height="25" />
I have listed some unaccomplished features you can start working on. Plus, you can even make a non-code contribution to Hacktoberfest by adding more features to this roadmap!
-   [x] Automatic Spaced Repetition Dates Setter <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="20" height="20" />
-   [x] Automatic Revision Scheduler <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="20" height="20" />
    -   [ ] Smart Revision Setter - Setting revision for notes whose strength is below a specific limit. <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="20" height="20" />
    -   [ ] Individual Date Selection for Each Note <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="20" height="20" />
-   [x] Flexible Parameters that can be modified using setting) <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Activities/Sparkles.png" alt="Sparkles" width="20" height="20" />
See the [open issues](https://github.com/SenaThenu/StudySphere/issues) for a full list of proposed features (and known issues).
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
<!-- CONTRIBUTING -->
## Contributing <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Waving%20Hand.png" alt="Waving Hand" width="25" height="25" />
Welcome Code Wizards & Witches! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People/Man%20Mage.png" alt="Man Mage" width="25" height="25" /><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People/Woman%20Mage.png" alt="Woman Mage" width="25" height="25" /> Your contributions fuel <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Fire.png" alt="Fire" width="25" height="25" /> this repo!!!
<br>
_Let's show the power <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Flexed Biceps.png" alt="Muscles" width="25" height="25" /> of Open-Source!_
<details>
    <summary>Why are open-source developers the sweetest folks in tech? <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Food/Lollipop.png" alt="Lollipop" width="25" height="25" /></summary>
    <p> Because they believe in sharing not only code but also <i>smiles <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Face with Hand Over Mouth.png" alt="Laugh" width="25" height="25" /></i> and <i>love <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Beating Heart.png" alt="Beating Heart" width="25" height="25" /></i> through 0s and 1s!</p>
</details>
<br>
-   Ways to Contribute <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Smiling Face with Open Hands.png" alt="Hugging Face" width="25" height="25" />
    -   [Open Issues](https://github.com/SenaThenu/repo_name/issues)
    -   [Update Readme](https://github.com/SenaThenu/repo_name/blob/main/README.md)
    -   [Make the Logo and the Assets Cooler](https://github.com/SenaThenu/repo_name/tree/main/slides)
    -   Introduce an **_awesome feature_** <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Glowing Star.png" alt="Glowing Star" width="25" height="25" />
        1. Fork the Project <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Food/Fork and Knife.png" alt="Fork" width="25" height="25" />
        2. Create your Feature Branch (`git checkout -b my_awesome_feature_branch`)
        3. Commit your Changes (`git commit -m 'Add some awesome features'`)
        4. Upstream this repository (`git remote add origin https://github.com/SenaThenu/StudySphere.git`)
        5. Push to the Main Branch of this repo (`git push origin my_awesome_feature_branch`)
        6. Open a Pull Request <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel and places/Rocket.png" alt="Rocket" width="25" height="25" />
        > If you want help with Git check out this Fireship video: [Git It!](https://www.youtube.com/watch?v=HkdAHXoRtos)
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>
## Current Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People/Man%20Mage.png" alt="Man Mage" width="25" height="25" />
<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Star-Struck.png" alt="Star Face" width="25" height="25" />This wouldn't exist if it weren't for these developers! **_Our Gratitude!!!_** ([emoji key](https://allcontributors.org/docs/en/emoji-key)): <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Symbols/Bubbles.png" alt="Bubbles" width="25" height="25" />
> "Even when I lose, I'm winning \
> 'Cause I give you all of me \
> And you give me all of you" \
> _~ All of Me - John Legend_
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="http://senathenu.github.io"><img src="https://avatars.githubusercontent.com/u/98274844?v=4?s=100" width="100px;" alt="Senash Thenuja"/><br /><sub><b>Senash Thenuja</b></sub></a><br /><a href="#code-SenaThenu" title="Code">💻</a> <a href="#doc-SenaThenu" title="Documentation">📖</a> <a href="#eventOrganizing-SenaThenu" title="Event Organizing">📋</a></td>
    </tr>
  </tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments \w <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Sparkling%20Heart.png" alt="Sparkling Heart" width="25" height="25" />
-   [Logo - Created by Freepik (on Flaticon)](https://www.flaticon.com/free-icon/world-book-day_4212483?term=world+book+day&page=1&position=8&origin=search&related_id=4212483)
-   [Documentation Template](https://github.com/othneildrew/Best-README-Template)
-   [G.R.O.W. Revision Method - Cajun Koi Academy](https://www.youtube.com/watch?v=N60JDe3a0IM)
-   [Ali Abdaal's Spaced Repetition Article](https://aliabdaal.com/spaced-repetition/)
-   [3D Animated Microsoft Style Emojis](https://animated-fluent-emoji.vercel.app/)
<p align="right"><a href="#readme-top">Jump to Top<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand gestures/Index Pointing Up.png" alt="Pointing Up" width="25" height="25" /></a></p>