Metadata-Version: 2.4
Name: almanac-bot
Version: 0.6.0
Summary: Almanac bot for Twitter.
Project-URL: homepage, https://github.com/logoff/almanac-bot
Project-URL: repository, https://github.com/logoff/almanac-bot
Project-URL: documentation, https://github.com/logoff/almanac-bot
Project-URL: Bug Tracker, https://github.com/logoff/almanac-bot/issues
Author: logoff
License-Expression: MIT
License-File: LICENSE.txt
Keywords: history,twitter
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4,>=3.12
Requires-Dist: babel<3,>=2.17.0
Requires-Dist: psycopg[binary]<4,>=3.2.4
Requires-Dist: schedule<2,>=1.2.2
Requires-Dist: sqlalchemy<3,>=2.0.38
Requires-Dist: tweepy<5,>=4.15.0
Requires-Dist: typer<0.16,>=0.15.1
Description-Content-Type: text/markdown

# Almanac Bot

[![PyPi package](https://img.shields.io/pypi/v/almanac-bot.svg)](https://pypi.python.org/pypi/almanac-bot)

Almanac bot for Twitter.

## Dependencies

* [Docker](https://www.docker.com/)
* [Python 3.12+](https://www.python.org/)
* [PostgreSQL 17.3+](https://www.postgresql.org/)
* [just](https://just.systems/)

## How to run it locally

1. Create a valid config file

```sh
cp config.ini.default config.ini
```

And fill the fields with valid values.

1. Launch it with Docker Compose

```sh
just docker-serve-site
```

Stop it with `Ctrl+C`.
