ScottG489 / ha-trello

Trello integration for Home Assistant
MIT License
8 stars 0 forks source link
hacs home-assistant trello

ha-trello

maintenance-status

Trello integration for Home Assistant.

Features

Planned features

Installation

First add this repository as a custom repository.

Setup

Prerequisites

Before setting up this integration, you need to get credentials by creating an Integration in Trello's Power-Up Admin Portal.

Create Integration and associated API key and Token 1. Ensure you're logged in to [Trello](https://trello.com/) in your browser. 2. Visit the [Power-Up Admin Portal](https://trello.com/power-ups/admin/) and select **New** near the top right. 3. Fill out all fields except the **Iframe connector URL**. 4. Select **Create** near the bottom right. 5. You should be taken to the **API key** page. Select **Generate a new API key** and select **Generate API key** if a dialog pops up. 6. Record the **API key** at the top of the page. *This will be the first of two credentials you'll need.* 7. At the end of the paragraph to the right of your **API key**, select the **Token** link to "... manually generate a Token." 8. You should be taken to a page with text at the top saying **"Would you like to give the following application access to your account?"**. Select the **"Allow"** button near the bottom right of the page. 9. On the following page, record your **Token**. *This will be the last credential you'll need.*

After you have both your API Key and Token you can start the integration setup.

Open your Home Assistant instance and start setting up a new integration.

Development

Run the following to set up your development environment

python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements_test.txt

To run Home Assistant with this integration loaded:

hass -c config

Testing

To run unit tests with coverage:

pytest tests --cov=custom_components.trello --cov-report term-missing

Releasing

Create a new GitHub release. The release workflow takes care of the rest. When finished, it will be available to download via HACS.

Troubleshooting

Ensure pip is at the latest version: pip3 install -r requirements_test.txt