A French NIC and Passport rendez-vous notifier

A python tool to get notified for French NIC and Passport rendez-vous from the ANTS service !

📔 Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Contact

🌟 About the Project

This Python script periodically searches for available rendez-vous slots for French national identity cards (CNI) and passports at https://rendezvouspasseport.ants.gouv.fr using the API provided by the French government. When a slot is found, it sends a notification to a Discord webhook.

🧰 Getting Started

‼️ Prerequisites

To run this script, you will need :

• python 3 or Docker (recommended)
• A discord webhook : see the official documentation

⚙️ Installation

Local

1. Clone this repository:

   git clone https://github.com/0xSysR3ll/ants-rdv-notify

2. Install the required packages:

   pip install -r requirements.txt

3. Copy the config/config-sample.yml to app/config/config.yml and edit the values to match your preferences.

4. Run the script:

   python3 main.py

Docker

1. Clone this repository:

   git clone https://github.com/0xSysR3ll/ants-rdv-notify

2. Copy the config/config-sample.yml to config/config.yml and edit the values to match your preferences.

3. Pull the official image on Docker Hub

   docker pull 0xsysr3ll/ants-rdv-notify:latest

4. Copy docker-compose.sample.yml to docker-compose.yml and adapt it to your needs.

5. Start the docker

   docker compose up -d

Configuration

Configuration File (config.yml) Documentation

General Settings

The config.yml file is used to configure various settings for an application. It contains the following settings: General Settings

• city: Specifies the city for which the application will retrieve information. The format is as follows: city: # City Name PostalCode. For example, city: # Paris 75000.

• reason: Specifies the reason for document retrieval. It can be one of the following options: CNI (National Identity Card), PASSPORT, or CNI-PASSPORT (for both). For example, reason: # CNI, PASSPORT, CNI-PASSPORT (for both).

• documents_number: Specifies the number of documents to be retrieved. It should be a value between 1 and 5. For example, documents_number: # From 1 to 5.

• radius_km: Specifies the radius in kilometers within which the application will search for document retrieval. It can be one of the following options: 20, 30, or 60. For example, radius_km: # 20, 30, 60 (kms).

Notifiers Settings

The notifiers section allows you to configure different notification systems. Currently, the following notifiers are supported: Discord Notifier

To enable Discord notifications, uncomment the following lines:

discord:
  webhook_url:

• webhook_url: Specifies the Discord webhook URL to which the application will send notifications. You can obtain the webhook URL by following the instructions provided in the Discord Webhooks documentation.

Telegram Notifier

To enable Telegram notifications, uncomment the following lines:

telegram:
    api_id:
    api_hash:
    channel_id:

• api_id: Specifies the API ID for your Telegram application. You can obtain this value by creating a new application on the Telegram API development platform and retrieving the API ID.

• api_hash: Specifies the API hash for your Telegram application. You can obtain this value from the same page where you retrieved the API ID.

• channel_id: Specifies the ID of the Telegram channel where the notifications will be sent. You need to create a Telegram channel and obtain the channel ID.

Note: Make sure to uncomment the necessary lines and provide the required values for the chosen notification systems.

👋 Contributing

Contributions are always welcome, I am not a pro developer !

🤝 Contact

0xSysr3ll - @0xsysr3ll - 0xsysr3ll@pm.me