Skip to content

Commit

Permalink
Update project metadata and CI for py312 🥧
Browse files Browse the repository at this point in the history
  • Loading branch information
todofixthis committed Oct 6, 2023
1 parent 40e8e0d commit 26e3ccf
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 10 deletions.
34 changes: 29 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: CI

on:
push:
push: ~

jobs:
build:
Expand All @@ -12,20 +12,44 @@ jobs:
python-version:
# Note: Use quotes to avoid float cast - especially important if the
# version number ends with 0!
- "3.9"
- "3.10"
- "3.11"
- "3.12"

steps:
- name: Clone Repo
- name: Clone repo
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
# https://github.com/actions/setup-python#caching-packages-dependencies
cache: pip
python-version: ${{ matrix.python-version }}
- name: Install Dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
- name: Run Tests
- name: Run tests
run: python -m unittest

docs:
runs-on: ubuntu-latest

steps:
- name: Clone repo
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
# https://github.com/actions/setup-python#caching-packages-dependencies
cache: pip
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs-builder]
- name: Check docs build
run: |
cd docs
mkdir -p _static
make html
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

python:
install:
- requirements: docs/requirements.txt

sphinx:
configuration: docs/conf.py
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Requirements
------------
Filters is known to be compatible with the following Python versions:

- 3.12
- 3.11
- 3.10
- 3.9

.. note::
I'm only one person, so to keep from getting overwhelmed, I'm only committing
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ Requirements
------------
Filters is known to be compatible with the following Python versions:

* 3.12
* 3.11
* 3.10
* 3.9

.. note::
I'm only one person, so to keep from getting overwhelmed, I'm only committing
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#id6
sphinx
sphinx_rtd_theme
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name = "phx-filters"
version = "3.3.0"
description = "Validation and data pipelines made easy!"
readme = "README.rst"
requires-python = ">= 3.6"
requires-python = ">= 3.10"
license = { file = "LICENCE.txt" }
authors = [
{ email = "Phoenix Zerin <[email protected]>" }
Expand All @@ -23,16 +23,16 @@ classifiers = [
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Software Development :: Libraries :: Python Modules",
'Topic :: Text Processing :: Filters',
]

dependencies = [
"phx-class-registry",
"phx-class-registry >= 4.1.0",
"python-dateutil",
"pytz",
"regex >= 2018.8.17",
Expand Down

0 comments on commit 26e3ccf

Please sign in to comment.