VULVY-RING-BOT

All-in-One Telegram Contraceptive Notification Bot

🚀 Overview

Vulvy-Ring-Bot is a privacy-first, multilingual Telegram bot designed to help users manage contraceptive ring cycles with timely notifications, calendar integration, and personalized settings.

✨ Features

• 📅 Cycle Calendar: Visualize your ring schedule and upcoming events.
• ⏰ Smart Reminders: Get notified for insertion, removal, and replacement.
• 🌍 Multilingual: Supports English, Italian, Spanish, French, and German.
• 🔒 Privacy-First: No unnecessary data collection.
• 🛠️ Easy Configuration: Intuitive commands and interactive setup.
• 📍 Timezone Awareness: Accurate reminders based on your location.

🛠️ Getting Started

Prerequisites

• Python 3.8+
• MongoDB (for persistent storage)
• pip
• Telegram Bot Token from @BotFather

Installation

Native Installation

1. Clone the repository

git clone https://github.com/pingmyheart/Vulvy-Ring-Bot.git
cd Vulvy-Ring-Bot
pip install -r requirements.txt

2. Set up environment variables

export MONGODB_USERNAME=root
export MONGODB_PASSWORD=root
export MONGODB_HOST=localhost
export MONGODB_DB=VulvyRing

export TG_BOT_TOKEN=XXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Docker Installation

1. Pull the docker image

docker pull ghcr.io/pingmyheart/vulvy-ring-bot:${VERSION}

2. Run the container

services:
  mongodb:
    image: mongo:latest
    environment:
      - MONGO_INITDB_ROOT_USERNAME=root
      - MONGO_INITDB_ROOT_PASSWORD=root
    volumes:
      - mongodb_data:/data/db
  vulvy-ring-bot:
    image: ghcr.io/pingmyheart/vulvy-ring-bot:${VERSION}
    environment:
      - MONGODB_USERNAME=root
      - MONGODB_PASSWORD=root
      - MONGODB_HOST=mongodb
      - MONGODB_DB=VulvyRing
      - TG_BOT_TOKEN=XXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Usage