Skip to content

Commit

Permalink
fix: more consistent about python and os vrs
Browse files Browse the repository at this point in the history
  • Loading branch information
dmyersturnbull committed Jul 29, 2022
1 parent 0537d0c commit 642f1ed
Show file tree
Hide file tree
Showing 32 changed files with 141 additions and 134 deletions.
1 change: 0 additions & 1 deletion .github/action-options.json

This file was deleted.

3 changes: 1 addition & 2 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,7 @@ branches:
require_code_owner_reviews: false
required_status_checks:
strict: true
contexts:
- "build (ubuntu-20.04, 3.9)"
contexts: []
enforce_admins: false
required_linear_history: true
restrictions: null
2 changes: 1 addition & 1 deletion .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
analyse:
analyze:
name: Analyze with CodeQL
runs-on: ubuntu-latest
steps:
Expand Down
23 changes: 19 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,36 @@ on:
repository_dispatch:
types: [release-made]
jobs:
deploy:
runs-on: ubuntu-20.04
test:
name: Test on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: ["ubuntu-22.04", "windows-2022", "macos-12"]
python: ["3.10"]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: "${{ matrix.python }}"
- name: Install build meta-dependencies
run: |
pip install poetry tox
- name: Test with tox
run: |
tox -v
deploy:
runs-on: ubuntu-20.04
needs: ["test"]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Build sdists and wheels with Poetry
run: |
poetry build
Expand All @@ -32,7 +47,7 @@ jobs:
- name: Attach artifacts to the GitHub release
uses: skx/github-action-publish-binaries@master
with:
args: "dist/*"
args: dist/*
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Publish to PyPi
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pull-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
strategy:
max-parallel: 1
matrix:
os: [ubuntu-20.04]
os: ["ubuntu-22.04"]
python-version: ["3.10"]
runs-on: "${{ matrix.os }}"
steps:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/push-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ on:
jobs:
build:
strategy:
max-parallel: 1
matrix:
os: ["ubuntu-20.04", "windows-2022", "macos-11"]
os: ["ubuntu-22.04", "windows-2022", "macos-12"]
python-version: ["3.10"]
name: "Test on ${{ matrix.os }} and ${{ matrix.python-version }}"
runs-on: "${{ matrix.os }}"
steps:
- name: Checkout
uses: actions/checkout@v3
- name: "Set up Python ${{ matrix.python-version }}"
uses: actions/setup-python@v4
with:
python-version: "${{ matrix.python-version }}"
python-version: "${{ matrix.python }}"
- name: Install build meta-dependencies
run: |
pip install poetry tox 'wheel>=0.36,<1.0'
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ formats: all
sphinx:
configuration: docs/conf.py
build:
os: ubuntu-20.04
os: "ubuntu-22.04"
tools:
python: "3.10"
python:
Expand Down
2 changes: 1 addition & 1 deletion .scrutinizer.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
build:
environment:
python: 3.9.0
python: 3.10.5
nodes:
my-tests:
dependencies:
Expand Down
8 changes: 1 addition & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,15 @@
Adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [0.11.x] - 2022-07-24
## [0.11.0] - 2022-07-24

### Changed

- Bumped Grayskull to v1 (1.4)
- Bumped CI and dev deps
- readthedocs, Docker, and Travis now use Python 3.10

## [0.11.x] - 2021-10-05

### Changed

- Bumped some versions
- Improved editorconfig, dockerignore, and gitignore
- readthedocs now uses Python 3.9
- Renamed `checks.yml` to `check.yml`
- Renamed workflows (`name` in the YMLs)

Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ keywords:
- python-template
message: Software reference
title: Tyrannosaurus
version: 0.11.0
version: 0.11.1
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ FROM python:3.10

# See https://github.com/opencontainers/image-spec/blob/master/annotations.md
LABEL name="tyrannosaurus"
LABEL version="0.11.0"
LABEL version="0.11.1"
LABEL vendor="dmyersturnbull"
LABEL org.opencontainers.image.title="tyrannosaurus"
LABEL org.opencontainers.image.version="0.11.0"
LABEL org.opencontainers.image.version="0.11.1"
LABEL org.opencontainers.image.url="https://github.com/dmyersturnbull/tyrannosaurus"
LABEL org.opencontainers.image.documentation="https://github.com/dmyersturnbull/tyrannosaurus"

Expand Down
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4485186.svg)](https://doi.org/10.5281/zenodo.4485186)
[![Created with Tyrannosaurus](https://img.shields.io/badge/Created_with-Tyrannosaurus-0000ff.svg)](https://github.com/dmyersturnbull/tyrannosaurus)

An opinionated, forwards-looking Python template for 2021.
An opinionated, forwards-looking Python template for 2021+.

Generate elegant, ready-to-use Python
projects that have excellent continuous integration and deployment (CI/CD). Integrated with
Expand Down Expand Up @@ -75,7 +75,7 @@ _[this workflow](https://github.com/dmyersturnbull/tyrannosaurus/blob/b6a731464a
### 🎁 Full features / integrations

- Packaging and dependency management with [Poetry](https://python-poetry.org/)
- Python 3.6 thru 3.10
- Python 3.6 thru 3.10 (probably 3.11 too)
- Only modern files: _no_ manifest file, setup.py, requirements.txt, setup.cfg, or eggs
- Continuous integration with [GitHub Actions](https://github.com/features/actions),
[Travis](https://www.travis-ci.com/), or
Expand Down Expand Up @@ -113,8 +113,6 @@ _[this workflow](https://github.com/dmyersturnbull/tyrannosaurus/blob/b6a731464a
and [Tyrannosaurus](https://tyrannosaurus.readthedocs.io/)
- IDE hints via [EditorConfig](https://editorconfig.org/) with good defaults for most languages
- Fancy [issue labels](https://github.com/crazy-max/ghaction-github-labeler)
- Slack notifications for CI/CD success and failure with [action-slack](https://github.com/8398a7/action-slack)
_note:_ temporarily disabled (0.10.x) due to an issue.
- Fancy GitHub-recognized readme, license,
[contributing guide](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors),
[issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates), and
Expand Down Expand Up @@ -171,22 +169,22 @@ Here are features that other tools lack:

#### 🏁 Feature table

| Tool | Main techs | CD kickoff | N int.† | modern‡ | Docker | Conda | sync | any-OS |
| ---------------------------------------------------------------------------------------- | -------------------------- | -------------- | ------- | ------- | ------ | ------ | ----- | ---- |
| Tyranosaurus | Actions, Poetry, Tox | git, GitHub | 30 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| [hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) | Actions, Poetry, Nox | git, Poetry | 20 | ✔️ | | | | ✔️ |
| [copier-poetry](https://github.com/pawamoy/copier-poetry) | Actions, Poetry, Make | git, manual | 15 | | ✔️ | | ✔️ | |
| [python-package-template](https://github.com/TezRomacH/python-package-template) | Actions, Poetry, Tox, Make | git, Make | 20 | ✔️ | ✔️ | | | |
| [pyscaffold](https://github.com/pyscaffold/pyscaffold) | setuptools, Tox | Gitlab, manual | 10 | | | | | ✔️ |
| [wemake-python-package](https://github.com/wemake-services/wemake-python-package) | Actions, Poetry, Make | git, Poetry | 10 | ✔️ | | | | |
| [best-practices](https://github.com/sourcery-ai/python-best-practices-cookiecutter) | Actions, pipenv | git, pipenv | 10 | | ✔️ | | | ✔️ |
| [python-blueprint](https://github.com/johnthagen/python-blueprint) | Actions, setuptools, Tox | git, manual | 5 | | ✔️ | | | ✔️ |
| [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) | Travis, setuptools, Tox | git, manual | 10 | | | | | |
| [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary) | Travis, setuptools, Tox | git, manual | 20 | | | | | |
| [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) | Actions, setuptools, Tox | git, manual | 15 | | ✔️ | | | ✔️ |
| [django-init](https://github.com/Fueled/django-init) | Actions, setuptools, Make | git, manual | 15 | | ✔️ | | | ✔️ |
| [docker-science](https://github.com/docker-science/cookiecutter-docker-science) | Make, Docker, setuptools | no CI/CD | 15 | | ✔️ | | | |
| [science-notebook-template](https://github.com/dmyersturnbull/science-notebook-template) | Conda | no CI/CD | 5 | | ✔️ | | | ✔️ |
| Tool | Main techs | CD kickoff | N int.† | modern‡ | Docker | Conda | sync | any-OS |
| ---------------------------------------------------------------------------------------- | -------------------------- | -------------- | ------- | ------- | ------ | ----- | ---- | ------ |
| Tyranosaurus | Actions, Poetry, Tox | git, GitHub | 30 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| [hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) | Actions, Poetry, Nox | git, Poetry | 20 | ✔️ | | | | ✔️ |
| [copier-poetry](https://github.com/pawamoy/copier-poetry) | Actions, Poetry, Make | git, manual | 15 | | ✔️ | | ✔️ | |
| [python-package-template](https://github.com/TezRomacH/python-package-template) | Actions, Poetry, Tox, Make | git, Make | 20 | ✔️ | ✔️ | | | |
| [pyscaffold](https://github.com/pyscaffold/pyscaffold) | setuptools, Tox | Gitlab, manual | 10 | | | | | ✔️ |
| [wemake-python-package](https://github.com/wemake-services/wemake-python-package) | Actions, Poetry, Make | git, Poetry | 10 | ✔️ | | | | |
| [best-practices](https://github.com/sourcery-ai/python-best-practices-cookiecutter) | Actions, pipenv | git, pipenv | 10 | | ✔️ | | | ✔️ |
| [python-blueprint](https://github.com/johnthagen/python-blueprint) | Actions, setuptools, Tox | git, manual | 5 | | ✔️ | | | ✔️ |
| [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) | Travis, setuptools, Tox | git, manual | 10 | | | | | |
| [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary) | Travis, setuptools, Tox | git, manual | 20 | | | | | |
| [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) | Actions, setuptools, Tox | git, manual | 15 | | ✔️ | | | ✔️ |
| [django-init](https://github.com/Fueled/django-init) | Actions, setuptools, Make | git, manual | 15 | | ✔️ | | | ✔️ |
| [docker-science](https://github.com/docker-science/cookiecutter-docker-science) | Make, Docker, setuptools | no CI/CD | 15 | | ✔️ | | | |
| [science-notebook-template](https://github.com/dmyersturnbull/science-notebook-template) | Conda | no CI/CD | 5 | | ✔️ | | | ✔️ |

**_N int._**: Approximate number of built-in integrations with tools and standards. What counts is very roughly defined.
**_Modern_**: Lacks legacy files and tools. I’m including Make, setuptools, pipenv, and some others.
Expand Down Expand Up @@ -215,7 +213,6 @@ These are some example projects that were generated with Tyrannosaurus:
- [suretime](https://github.com/dmyersturnbull/suretime)
- [service-it](https://github.com/dmyersturnbull/service-it)
- [chemserve](https://github.com/dmyersturnbull/chemserve)
- [valar-dagger](https://github.com/dmyersturnbull/valar-dagger)
- [pocketutils](https://github.com/dmyersturnbull/pocketutils)
- [auth_capture_proxy](https://github.com/alandtse/auth_capture_proxy)

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These versions of Tyrannosaurus are supported.

| Version | Supported |
| ------- | ------------------ |
| 0.10.0 | :white_check_mark: |
| 0.11.x | :white_check_mark: |

## How to report a vulnerability

Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ channels:
- conda-forge
dependencies:
- python>=3.8,<4
- tomlkit>=0.7,<1
- tomlkit>=0.8,<1
- typer>=0.6,<1
- requests>=2.26,<3
- grayskull>=1.4,<2.0

0 comments on commit 642f1ed

Please sign in to comment.