diff --git a/.copier-answers.yml b/.copier-answers.yml index 57a5383..0ff67c3 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: v0.5.2 +_commit: v0.6.2 _src_path: gl:climate-resource/copier-core-python-repository email: zebedee.nicholls@climate-energy-college.org initial_setup: true @@ -12,3 +12,4 @@ project_name_human: OpenSCM-Units project_name_pip: openscm-units project_name_python: openscm_units project_url: https://github.com/openscm/openscm-units +track_lock_file: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7ff7065..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,9 +0,0 @@ -## Description - -## Checklist - -Please confirm that this pull request has done the following: - -- [ ] Tests added -- [ ] Documentation added (where applicable) -- [ ] Changelog item added to `changelog/` diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml index 376b67b..5834ccd 100644 --- a/.github/actions/setup/action.yml +++ b/.github/actions/setup/action.yml @@ -30,7 +30,10 @@ runs: pipx install poetry which poetry poetry --version # Check poetry installation - - name: Lock poetry # lock file is needed for the next step, but we don't track our lock file + - name: Lock poetry + # Lock file is needed for the next step, + # but we don't track our lock file + # so we we generate one here. shell: bash run: poetry lock - name: Set up Python ${{ inputs.python-version }} diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 04465b6..46a85c6 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -107,6 +107,8 @@ jobs: - name: Check build run: | tar -tvf dist/openscm_units-*.tar.gz --wildcards '*openscm_units/py.typed' + tar -tvf dist/openscm_units-*.tar.gz --wildcards 'openscm_units-*/LICENCE' + check-dependency-licences: runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index fcd2a9a..373be90 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ # Notebooks *.ipynb +# Lock file +poetry.lock + # Databases *.db diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9543d49..28ed48e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,14 +11,19 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.9" + python: "3.11" jobs: post_create_environment: - pip install poetry - poetry config virtualenvs.create false post_install: - - poetry install --with docs --all-extras + # RtD seems to be not happy with poetry installs, + # hence use pip directly instead. + - poetry export -f requirements.txt --output requirements.txt --with docs + - python -m pip install -r requirements.txt + - python -m pip install . + - python -m pip list -# Build documentation in the docs/ directory with Sphinx +# Set sphinx configuration sphinx: configuration: docs/source/conf.py diff --git a/LICENSE b/LICENCE similarity index 100% rename from LICENSE rename to LICENCE diff --git a/README.md b/README.md index 71707b7..29a0ce4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Handling of units related to simple climate modelling. [![PyPI install](https://github.com/openscm/openscm-units/actions/workflows/install.yaml/badge.svg?branch=main)](https://github.com/openscm/openscm-units/actions/workflows/install.yaml) **Other info :** -[![License](https://img.shields.io/github/license/openscm/openscm-units.svg)](https://github.com/openscm/openscm-units/blob/main/LICENSE) +[![Licence](https://img.shields.io/github/license/openscm/openscm-units.svg)](https://github.com/openscm/openscm-units/blob/main/LICENCE) [![Last Commit](https://img.shields.io/github/last-commit/openscm/openscm-units.svg)](https://github.com/openscm/openscm-units/commits/main) [![Contributors](https://img.shields.io/github/contributors/openscm/openscm-units.svg)](https://github.com/openscm/openscm-units/graphs/contributors) diff --git a/pyproject.toml b/pyproject.toml index aa24b0e..b4fc2d6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,6 +12,7 @@ authors = [ readme = "README.md" packages = [{include = "openscm_units", from = "src"}] license = "BSD-3-Clause" +include = ["LICENCE"] # poetry uses US English so assumes it will be spelt LICENSE [tool.poetry.dependencies] python = "^3.9"