Metadata-Version: 2.1
Name: python-eol
Version: 0.0.2
Summary: Simple tool to check if python version is past EOL
Author-email: Martin Imre <martinimre25@gmail.com>
Project-URL: Source, https://github.com/mimre25/python-eol
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# python-eol
A simple tool to check if the current running python version is beyond or close to end of life (eol).

Warns 60 days before eol, and errors when using a python version that is beyond eol.

## Motivation
We tend to often forget which python version we are using for a project and that those version eventually will not get security updates once they are beyond eol.
This tool can be used to check this, for example, in a CI/CD system or as a pre-commit hook.

## Installation
```sh
pip install python-eol
```

## Usage
Simply invoke `eol` from your command line
```sh
eol
```
**Options**:
```sh
  --fail-close-to-eol   Fail if the python version is close to eol instead of just warn
  --check-docker-files  Search for Dockerfile (**/*Dockerfile*) and check the python versions specified inside them
```

## Pre-commit-hook
Add the following to your `.pre-commit-config.yaml`:
```yaml
repos:
  - repo: https://github.com/mimre25/python-eol/
    rev: v0.0.2
    hooks:
      - id: python-eol-check
```
