An open API service indexing awesome lists of open source software.

https://github.com/derdp/chirptools

ChirpStack Tool that enabeld bulk import and bulk sensors move, delete actions.
https://github.com/derdp/chirptools

Last synced: 5 months ago
JSON representation

ChirpStack Tool that enabeld bulk import and bulk sensors move, delete actions.

Awesome Lists containing this project

README

          

## ChirpTools

A Flask application to manage ChirpStack assets (bulk import, bulk move, bulk delete, etc.).

## ๐Ÿ“ฆ Requirements ::

- Git
- Python 3.9+
- Docker & Docker Compose (for containerized setup)

## ๐Ÿงช Clone the Repository

```bash
git clone https://gitlab.opencode.de/smart-city-potsdam/udp-lorawan/tools.git
cd ChirpTools
```

## โš™๏ธ Environment Configuration

Copy `.env.example` to `.env` and adjust environment variables as needed:

```bash
cp .env.example .env
```

---

## ๐Ÿณ Run with Docker

Build and run the app using Docker Compose:

```bash
docker-compose up --build
```

- App will be available at: `http://localhost:5000`
- Make sure `.env` is configured correctly before running

To stop the app:

```bash
docker-compose down
```

---

## ๐Ÿงช Run Locally (Python venv)

1. Create a virtual environment:

```bash
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate
```

2. Install requirements:

```bash
pip install -r requirements.txt
```

3. Set environment variables from `.env` (or export them manually)

4. Start the Flask app:

```bash
python -m flask --app main run --debug
```

App will be accessible at: `http://localhost:5000`

---

## **Warning:**

โš ๏ธ Authentication is not yet implemented.
๐Ÿšซ Do not expose this app to the public.
๐Ÿ”’ Keep it local until authentication is added.