CLI tool to export Trello board data to a CSV file.
Project description
Trello CSV Exporter
A simple command-line tool to export Trello board data into a CSV-compatible Excel file. You can choose to save the file locally or upload it directly to an AWS S3 bucket.
Features
- Export Trello data: Export your Trello board’s cards, lists, and labels into an Excel sheet.
- Save locally or upload to S3: Save the generated file to a local directory or upload it directly to AWS S3.
- AWS profile support: Optionally configure AWS profiles for seamless S3 uploads.
Installation
1. Install the tool via pip
You can install the tool from PyPI:
pip install trello-csv
2. Set up your credentials
-
Trello API Key and Token: You will need your Trello API key and token. These can be obtained from the Trello Developer Page. You can store these in a
.envfile or set them as environment variables. -
AWS Credentials (optional for S3 uploads): Set up your AWS credentials through the AWS CLI or environment variables for S3 uploads.
Example .env File:
TRELLO_API_KEY=your_api_key
TRELLO_ACCESS_TOKEN=your_access_token
AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key
AWS_REGION=your_aws_region
Usage
1. Export Trello Board Data
Run the following command to start the exporter:
trello-csv
2. Specify Output Directory
You can specify where to save the generated file:
- Save Locally (to a specific directory):
trello-csv --output-dir ./csv
If the --output-dir option is omitted, the file will be saved to your system’s default Downloads folder:
-
macOS/Linux:
~/Downloads -
Windows:
C:\Users\YourUsername\Downloads -
Upload to AWS S3:
trello-csv --output-dir s3://your-bucket-name/path/to/directory/
3. Specify AWS Profile (optional)
If you use multiple AWS profiles, you can specify the profile to use:
trello-csv --aws-profile my-aws-profile
Example Command
- Save file locally:
trello-csv --output-dir ./trello_exports
- Upload to AWS S3:
trello-csv --output-dir s3://my-bucket/trello_exports --aws-profile my-aws-profile
This will export your Trello board data to ./trello_exports or directly to the S3 bucket my-bucket/trello_exports.
Development (Optional)
If you want to contribute or build the project locally, here are the steps:
1. Clone the repository:
git clone https://github.com/your-username/trello-csv-exporter.git
cd trello-csv-exporter
2. Set up the virtual environment and install dependencies:
python -m venv venv
source venv/bin/activate # On Linux/macOS
.\venv\Scripts\activate # On Windows
pip install -r requirements.txt
3. Build the package:
To build the package locally, run:
make install
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file trello_csv-1.0.1.tar.gz.
File metadata
- Download URL: trello_csv-1.0.1.tar.gz
- Upload date:
- Size: 18.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da3b2f50a963164397145c5536b4c683782ccebec3d06293aa344d4a6eea3775
|
|
| MD5 |
8a3542f8ff816a224d11c5ba98eccbcf
|
|
| BLAKE2b-256 |
d2a2666713fbc9976171a93b29b3f078b2d5722d8ae214bcec6a4fd487af117b
|
File details
Details for the file trello_csv-1.0.1-py3-none-any.whl.
File metadata
- Download URL: trello_csv-1.0.1-py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a353c08fde5b7b4e47b9484a08b3be2620fa1b5138f55619dba3a575dd075489
|
|
| MD5 |
65a560f620715a0441f2b932a10ff999
|
|
| BLAKE2b-256 |
406b6b3cbf2128962ccb7fd2e0785fff4dae29f35d43571c96f4b17d78365862
|