cogeol

Align with supported Python versions - automated with endoflife.date

✨ Features 🚀 Quick start 📚 Documentation 🤝 Contribute 👍 Adopters 📜 Legal

---

Features

cogeol is a library which allows you to:

• Works with any file format (e.g. updating Python versions in CI/CD tests)
• No need to track Python EOL dates — cogeol does it for you
• Align with Scientific Python SPEC0: cogeol will allow you to align your project to the three latest supported Python versions
• Caching: retrieves data from https://endoflife.date/ and stores it locally to minimize network requests
• Based on cog: Manage versions of Python by statically generated code (see examples below!)

Quick start

Installation

> pip install cogeol

Usage

Tip

Check out the documentation for all available functionalities and public-facing API.

1. Open pyproject.toml of your project and find necessary to have requires-python field.
2. Update it as follows (comments are crucial!):

# [[[cog
# import cog
# import cogeol
#
# cycle = cogeol.scientific()[-1]["cycle"]
# cog.out(f'requires-python = ">={cycle}"')
# ]]]
requires-python = ">=3.9"
# [[[end]]]

Now run the following from the command line:

> cog -c -r pyproject.toml

Now your requires-python field will be updated to the latest supported Python version!

For example (Python 3.11 is the latest supported version at the time of writing):

# [[[cog
# import cog
# import cogeol
#
# cycle = cogeol.scientific()[-1]["cycle"]
# cog.out(f'requires-python = ">={cycle}"')
# ]]]
requires-python = ">=3.11"
# [[[end]]] (sum: uZEo+p96oZ)

Note

Please notice a checksum, which verifies consistency of the changes at each run

Examples

Specifying Python version classifiers (click me)

 

You can automate the classifiers in your pyproject.toml file like this:

# [[[cog
# import cog
# import cogeol
#
# for version in reversed(cogeol.scientific()):
#     cycle = version["cycle"]
#     cog.outl(f'  "Programming Language :: Python :: {cycle}",')
# ]]]
"Programming Language :: Python :: 3.11",
# [[[end]]]

Now run the following from the command line:

> cog -c -r pyproject.toml

and you should see the following (notice all versions are present!):

# [[[cog
# import cog
# import cogeol
#
# for version in reversed(cogeol.scientific()):
#     cycle = version["cycle"]
#     cog.outl(f'  "Programming Language :: Python :: {cycle}",')
# ]]]
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
# [[[end]]] (sum: FeG7grp2Dw)

Caching (click me)

 

Let's assume you have the following code snippet in github-workflow.yml:

...
jobs:
  tests-reusable:
    strategy:
      matrix:
        python:
          #
          #           DO NOT EDIT UNTIL end marker
          #
          # [[[cog
          # import cog
          # import cogeol
          #
          # for version in reversed(cogeol.scientific()):
          #     cycle = version['cycle']
          #     cog.outl(f'          - "{cycle}"')
          # ]]]
          - "3.11"
          # [[[end]]] (sum: l3d2zGv79j)

in addition to your code in pyproject.toml using cogeol.

Now, if you run:

> cog -c -r pyproject.toml github-workflow.yml

The following will happen:

• Both files will be updated with appropriate Python versions
• Only one call to End of Life Date will be made (the results are cached on disk)

Next time you run the same command, the results will be read from the cache

Advanced (click me)

 

For more examples check out this project's:

• pyproject.toml file (see here)
• Tests of the last three versions in GitHub Actions workflow (see here)

Contribute

We welcome your contributions! Start here:

• Code of Conduct
• Contributing Guide
• Roadmap
• Changelog
• Report security vulnerabilities
• Open an Issue

Legal

• This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
• This project is copyrighted by open-nudge - the appropriate copyright notice is included in each file.