2023-09-04 19:12:44 +02:00
# Baserow IFTO API Wrapper
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
This repository contains a Python-based API wrapper for Baserow, designed to provide Input, Filter, Transform, and Output (IFTO) functionalities for Baserow data.
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
## Features
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
- Fetch all rows from a specific table in Baserow.
- Fetch all tables from a specific database in Baserow.
- Fetch all data from a specific database in Baserow.
- Handle API responses, including error checking and JSON decoding.
- Merge tables based on references.
- Command-line interface for fetching data.
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
## Getting Started
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
### Prerequisites
2023-09-03 20:22:20 +02:00
- Python 3.x
2023-09-04 19:12:44 +02:00
- `requests` library. Install it using:
```bash
pip install requests
` ``
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
### Usage
2023-09-03 20:22:20 +02:00
1. Clone this repository:
2023-09-04 19:12:44 +02:00
` ``bash
git clone https://github.com/yourusername/baserow-ifto.git
cd baserow-ifto
` ``
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
2. Use the script with the required arguments:
` ``bash
python controller.py BASE_URL API_KEY --database_id DATABASE_ID
` ``
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
Replace ` BASE_URL`, ` API_KEY`, and ` DATABASE_ID` with the appropriate values:
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
- ` BASE_URL`: Base URL of your Baserow instance, e.g., ` https://YOUR_BASEROW_INSTANCE_URL/api/`
- ` API_KEY`: Your Baserow API key.
- ` DATABASE_ID`: ID of the Baserow database you want to fetch data from.
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
The script will fetch all the data from the specified Baserow database and print it to the console.
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
### Additional Options
2023-09-03 20:22:20 +02:00
2023-09-04 19:12:44 +02:00
- ` --table_ids`: Specify IDs of the Baserow tables you want to fetch data from, separated by commas.
- ` --matrix`: Merge tables based on references.
- ` -v` or ` --verbose`: Enable verbose mode for debugging.
- ` --linked_fields`: Outputs the linked tables.
- ` --quiet`: Suppress output of JSON.
## License
All rights to this code belong in equal parts to [Marco Petersen ](mailto:m@rcopetersen.com ) and [Kevin Veen-Birkenbach ](mailto:kevin@veen.world ).
2023-09-03 20:22:20 +02:00
## Contributing
2023-09-04 19:12:44 +02:00
If you have suggestions, improvements, or any issues, feel free to open an issue or submit a pull request. Your contributions are always welcome!