grigoriy/tg-weather-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Simple tg weather bot written in C
54 commits 2 branches 11 tags 108 KiB
Find a file
Exact
Grigoriy Efimov b5a43bd74f Delete atrifacts
2024-04-08 21:10:05 +03:00
.github/workflows Add static analysis and build checking 2024-01-21 21:17:04 +03:00
docker Add more strict build for CI 2024-04-08 00:01:22 +03:00
src Delete atrifacts 2024-04-08 21:10:05 +03:00
.gitignore Add valgrind and build artifacts to gitignore 2023-09-10 19:19:18 +03:00
example.env Add log function 2023-08-20 23:27:32 +03:00
LICENSE Initial commit 2023-08-01 22:44:12 +03:00
Makefile Improve Makefiles 2024-01-21 21:35:39 +03:00
README.md Add more strict build for CI 2024-04-08 00:01:22 +03:00

README.md

tg-weather-bot

Build and publish Docker image Build Cppcheck static analysis
Simple tg weather bot written in C

Description

To get the weather information for a specific city, write to the bot with the name of the city you want to know the weather for. The bot will provide you with the weather condition, temperature, humidity, pressure, and wind speed in that location. The bot utilizes the OpenWeather API to fetch the weather data. Bot written in C, wrapped in docker container.

License

This project is licensed under the terms of the MIT License. See the LICENSE file for details.

Installation

To get started with tg-weather-bot, follow these steps:

  1. Clone the repository:

git clone https://github.com/CatInBeard/tg-weather-bot.git

  1. Obtain a Telegram Bot API token and set it in the .env file by copying the exmaple.env file and fill TG_TOKEN variable. You can create a bot and obtain the token by following the instructions provided by BotFather.

  2. Obtain openweather API token and set it in the .env file by copying the exmaple.env file and fill OW_TOKEN variable. You can obtain the token by following the instructions provided by openweather.

  3. Build container:
    make build-server

  4. Start bot:

make run

The bot should now be up and running.

Docker Hub

You can run tg-weather-bot using Docker Hub. Follow these steps:

  1. Pull the Docker image from Docker Hub:

    docker pull catinbeard/tg-weather-bot:latest

  2. Run the container:

docker run -d -v $PWD/data:/app catinbeard/tg-weather-bot:latest -e TG_TOKEN='YOUR_BOT_TOKEN' -e OW_TOKEN='YOUR_OW_TOKEN'

The tg-weather-bot will can now be running inside the Docker container.

Building without Docker

Alternatively, you can do without a container builder and work without a server container. Follow these steps:

  1. Clone the repository:

git clone https://github.com/CatInBeard/tg-weather-bot.git

  1. Install the required dependencies using package manager:
  • Debian/Ubuntu apt update && apt install gcc musl-dev make curl libjson-c-dev
  • Arch sudo pacman -S gcc make curl json-c
  • Fedora dnf install gcc make curl json-c
  • Alpine apk add gdb gcc musl-dev make curl curl-dev json-c json-c-dev

  1. Compile: go to the src directory and run make all

  2. Install: make install

  3. Run: tg-weather-bot or nohup tg-weather-bot >/dev/null 2>&1 & for background usage

  4. Cron (optional) You can add cronjob after system startup: open crontab with crontab -e and add @reboot nohup tg-weather-bot >/dev/null 2>&1 &

Debug

You can build the debug version and open it with gdb:
make debug
If you are not using Docker and simply want to build the debug version, go to the src directory and run:
make build DEBUG=1 STRICT=0

STRICT=0 is needed to disable the -Werror flag, so that build errors are displayed but do not stop the build.

Profiling

You can build the debug version and run it with gprof:
make profile
If you are not using Docker and simply want to build the profiling version, go to the src directory and run:
make build PROFILE=1

Valgrind

You can generate valgrind report with:
make valgrind