kevinveenbirkenbach/baserow-ifto
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/baserow-ifto.git synced 2024-12-04 07:49:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach 2023-09-04 19:12:44 +02:00
parent fa84080068
commit 74e5f3e73f
1 changed files with 40 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -1,45 +1,59 @@
# baserow-ifto
# Baserow IFTO API Wrapper
This repository contains the Input Filter Transform and Output (IFTO) scripts to work with Baserow data.
This repository contains a Python-based API wrapper for Baserow, designed to provide Input, Filter, Transform, and Output (IFTO) functionalities for Baserow data.
## Usage
## Features
### Fetching All Data from a Baserow Database
- 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.
We have a Python script that allows you to fetch all data from a Baserow database using its API.
## Getting Started
#### Requirements
### Prerequisites
- Python 3.x
- `requests` library. You can install it using pip:
- `requests` library. Install it using:
```bash
pip install requests
```
```bash
pip install requests
```
#### How to Use
### Usage
1. Clone this repository:
```bash
git clone https://github.com/yourusername/baserow-ifto.git
cd baserow-ifto
```
```bash
git clone https://github.com/yourusername/baserow-ifto.git
cd baserow-ifto
```
2. Use the script with the required arguments:
```bash
python controller.py BASE_URL API_KEY --database_id DATABASE_ID
```
2. Run the script with the required arguments:
Replace `BASE_URL`, `API_KEY`, and `DATABASE_ID` with the appropriate values:
```bash
python fetch-all-data.py BASE_URL API_KEY DATABASE_ID
```
- `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.
Replace `BASE_URL`, `API_KEY`, `DATABASE_ID` with the appropriate values:
The script will fetch all the data from the specified Baserow database and print it to the console.
- `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.
### Additional Options
The script will then fetch all the data from the specified Baserow database and print it to the console.
- `--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).
## Contributing
If you have suggestions or improvements, feel free to open an issue or submit a pull request. Your contributions are welcome!
If you have suggestions, improvements, or any issues, feel free to open an issue or submit a pull request. Your contributions are always welcome!