https://github.com/exhumer/pyexf1lt

Unofficial F1 live timing client
https://github.com/exhumer/pyexf1lt

discord formula1 python

Last synced: 19 days ago
JSON representation

Unofficial F1 live timing client

• Host: GitHub
• URL: https://github.com/exhumer/pyexf1lt
• Owner: eXhumer
• License: agpl-3.0
• Archived: true
• Created: 2022-03-29T08:56:14.000Z (almost 3 years ago)
• Default Branch: dev
• Last Pushed: 2023-03-03T12:32:37.000Z (almost 2 years ago)
• Last Synced: 2024-09-21T18:25:46.310Z (5 months ago)
• Topics: discord, formula1, python
• Language: Python
• Homepage: https://pypi.org/project/exfolt
• Size: 371 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING.md

Awesome Lists containing this project

README

        
# eXF1LT

Python unofficial F1 live timing client.

## Package Installation Guide

### Requires

* Python 3.11+

* pip package manager

### Install from source

```console

# To install timing client

pip install -e git+https://github.com/eXhumer/pyeXF1LT.git@dev#egg=exfolt

# To use live Discord bot (Optional)

pip install -e git+https://github.com/eXhumer/pyeXDC.git@dev#egg=exdc

```

Upon package installation, `eXF1LT` executable will be available in your Python environment to use this library as a standalone program. Discord messaging action will be unavailable from executable unless [eXDC](https://github.com/eXhumer/pyeXDC) is installed. Use `eXF1LT --help` to view available executable actions.

## Discord environment variables

Discord environment variables can be specified via external file with `--env-path` formatted like [this](./discord.env.example), by creating a `discord.env` file in current console directory, or it can also be specified in OS environment. **OS environment requires all variable names to be prefixed with `EXFOLT_`**. A combination of `WEBHOOK_ID` and `WEBHOOK_TOKEN` or `BOT_TOKEN` and `CHANNEL_ID` will be required to use the Discord bot functionality. By default, the `discord.env.example` file uses a emojis from a privately hosted Discord server, but it can easily be changed as well via environment file or OS environment as well.

## Disclaimer / Notice

eXF1LT is an unofficial software and is not associated in anyway with Formula 1 or any of its companies.

## Special Thanks

* [theOehrly](https://github.com/theOehrly) and their work on [Fast-F1](https://github.com/theOehrly/Fast-F1) package. Some documented aspect of live timing has been used in this project.

* [recursiveGecko](https://github.com/recursiveGecko) helping me figure out the decompression of CarData.z and Position.z datas & client connection issue related to GCLB cookie.

## Licensing

This project is licensed under OSI Approved [GNU AGPLv3 **ONLY**](./COPYING.md).