Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakegodsall/notion-dashboard
An AWS Lambda function for syncing various different services with Notion databases
https://github.com/jakegodsall/notion-dashboard
aws-sam lambda-functions lingq notion notion-api whoop
Last synced: 3 days ago
JSON representation
An AWS Lambda function for syncing various different services with Notion databases
- Host: GitHub
- URL: https://github.com/jakegodsall/notion-dashboard
- Owner: jakegodsall
- License: mit
- Created: 2024-11-25T18:28:49.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-29T18:49:22.000Z (4 days ago)
- Last Synced: 2024-12-29T19:18:19.464Z (4 days ago)
- Topics: aws-sam, lambda-functions, lingq, notion, notion-api, whoop
- Language: Python
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notion Dashboard
The **Notion Dashboard** app integrates data from different services
into a Notion database, helping you track and manage your activities seamlessly.
## Integrations
- **LingQ Integration**: Sync your daily word counts into a Notion database.
- **WHOOP Integration**: Track your workouts, including metrics like heart rate, duration, and calories burned.
---
## Installation
1. Clone the repository:
```bash
git clone https://github.com/jakegodsall/notion-dashboard.git
cd notion-dashboard
```
2. Create and activate a virtual environment:
```bash
python3 -m venv .venv
source .venv/bin/activate
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
4. Configure the app:
- Add your Notion API credentials and database configurations to the `src/config/notion.config.yml` file.
---
## Usage
### Run Manually
The app can be run as a command-line tool using the `main.py` file:
```bash
python main.py
```
### Run as an AWS Lambda Function
The app includes a `lambda.py` file for running as an AWS Lambda function. This is useful for deploying the app to AWS Lambda for serverless execution.
The project is set up using AWS SAM (Serverless Application Model) for easy deployment. To deploy:
1. Install the AWS SAM CLI if not already installed:
```bash
brew install aws-sam-cli
```
2. Build the project:
```bash
sam build
```
3. Deploy the application:
```bash
sam deploy --guided
```
Follow the prompts to configure the environment variables and other configurations for deployment.
---
## Configuration
### Notion API
Create a `notion.config.yml` file in `src/config` with the following structure:
```yaml
notion:
key: "notion-key"
integrations:
whoop:
database_id: "database-id"
field_mappings:
date:
label: "Date"
key: "date"
type: "date"
duration:
label: "Duration"
key: "duration"
type: "number"
distance:
label: "Distance (km)"
key: "distance"
type: "number"
```
---
## Troubleshooting
### Common Errors
#### FileNotFoundError: `notion.config.yml`
- Ensure the configuration file exists at `src/config/notion.config.yml` with valid Notion API credentials.
#### ModuleNotFoundError
- Check that your `PYTHONPATH` includes the project root directory:
```bash
export PYTHONPATH=/path/to/notion-dashboard
```
---
## Contributing
1. Fork the repository.
2. Create a new feature branch:
```bash
git checkout -b my-new-feature
```
3. Commit your changes:
```bash
git commit -am 'Add some feature'
```
4. Push to the branch:
```bash
git push origin my-new-feature
```
5. Open a pull request.
---
## License
This project is licensed under the MIT License. See `LICENSE` for details.