https://github.com/wtbates99/pandas-monday
Python library that provides seamless integration between pandas DataFrames and Monday.com boards. Easily read Monday.com board data into pandas DataFrames with support for subitems, pagination, and column filtering. Built with the Monday.com GraphQL API.
https://github.com/wtbates99/pandas-monday
api-wrapper data-analysis data-integration dataframe graphql monday pandas productivity-tools python
Last synced: 7 months ago
JSON representation
Python library that provides seamless integration between pandas DataFrames and Monday.com boards. Easily read Monday.com board data into pandas DataFrames with support for subitems, pagination, and column filtering. Built with the Monday.com GraphQL API.
- Host: GitHub
- URL: https://github.com/wtbates99/pandas-monday
- Owner: wtbates99
- License: mit
- Created: 2024-12-17T14:16:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-20T16:44:32.000Z (9 months ago)
- Last Synced: 2025-01-20T17:43:26.027Z (9 months ago)
- Topics: api-wrapper, data-analysis, data-integration, dataframe, graphql, monday, pandas, productivity-tools, python
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pandas-monday
The goal is to create a Python package that enables seamless integration between pandas DataFrames and Monday.com boards. This library allows you to easily read data from Monday.com boards into pandas DataFrames and write DataFrames back to Monday.com boards.
## Installation
**You cannot currently install this package from PyPI using pip install.**
Instead, clone the repository and install the requirements:
```bash
git clone https://github.com/wtbates99/pandas-monday.git
cd pandas-monday
pip install -r requirements.txt
```
## Quick Start
```python
import pandas_monday as pm
# Initialize client using environment variable MONDAY_API_TOKEN
client = pm.monday_pandas()
# Or explicitly pass your API token
client = pm.monday_pandas(api_token="your-api-token")
# Read from a board
df = client.read_board(board_id="your-board-id")
```
## Features
- Read Monday.com boards into pandas DataFrames
- Write pandas DataFrames to Monday.com boards
- Support for subitems
- Multiple write modes and overwrite options
- Automatic type conversion between pandas and Monday.com
- Error handling and validation
## Authentication
To use this package, you'll need a Monday.com API token. You can either:
1. Set it as an environment variable named `MONDAY_API_TOKEN`
2. Pass it directly when initializing the client
To get an API token:
1. Go to your Monday.com account
2. Click on your avatar in the bottom left
3. Go to Developer > API
4. Generate a new token
## Usage Examples
### Reading from Monday.com
```python
import pandas_monday as pm
client = pm.monday_pandas()
# Basic read
df = client.read_board(board_id="your-board-id")
# Read with subitems
df = client.read_board(
board_id="your-board-id",
include_subitems=True
)
# Read specific columns
df = client.read_board(
board_id="your-board-id",
columns=['name', 'status', 'numbers']
)
```
### Writing to Monday.com
```python
import pandas as pd
import pandas_monday as pm
client = pm.monday_pandas()
# Read your data
df = pd.read_csv("data.csv")
# Write to board
client.write_board(
board_id="your-board-id",
df=df,
mode="replace", # Options: "append", "replace"
overwrite_type="archive" # Options: "archive", "delete"
)
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.