Merge pull request #2 from xdurana/change-python-version

xdurana · Jul 25, 2022 · 5858f99 · 5858f99
2 parents 2281873 + 31ef419
commit 5858f99
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 14 deletions.
diff --git a/.github/actions/setup-poetry-env/action.yml b/.github/actions/setup-poetry-env/action.yml
@@ -6,7 +6,7 @@ inputs:
    python-version:
      required: false
      description: "The python version to use"
-     default: 3.9.7
+     default: 3.9.12
 runs:
   using: "composite"
   steps:

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-PYTHON_VERSION := 3.9.7
+PYTHON_VERSION := 3.9.12
 
 bake: ## bake without inputs and overwrite if exists.
 	@cookiecutter --no-input . --overwrite-if-exists

diff --git a/README.md b/README.md
@@ -1,16 +1,14 @@
 # Cookiecutter PyPackage
 
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
+[![Supported Python versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)](https://www.python.org/downloads/)
 [![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://xdurana.github.io/cookiecutter-pypackage/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/cookiecutter-pypackage)](https://img.shields.io/pypi/dm/cookiecutter-pypackage?style=flat-square)
 
 This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
 repository to generate the file structure for a Python project that uses
 [Poetry](https://python-poetry.org/) for its dependency management.
 
 - **Documentation**: [Link](https://xdurana.github.io/cookiecutter-pypackage/)
 - **Example repository**: [Link](https://github.com/xdurana/cookiecutter-pypackage-example)
-- **PyPi**: [Link](https://pypi.org/project/cookiecutter-pypackage/)
 
 ## Features
 
@@ -73,4 +71,4 @@ For activating the automatic documentation with MkDocs, see
 This project is partially based on [Audrey
 Feldroy's](https://github.com/audreyfeldroy) great
 [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) and [
-Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-pypackage).
+Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
diff --git a/docs/index.md b/docs/index.md
@@ -1,10 +1,7 @@
 
 # Cookiecutter PyPackage
 
-[![Release](https://img.shields.io/github/v/release/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
-[![Build status](https://img.shields.io/github/workflow/status/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage/merge-to-main)](https://img.shields.io/github/workflow/status/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage/merge-to-main)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
-[![License](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage)](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage)
+[![Supported Python versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)](https://www.python.org/downloads/)
 
 This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
 repository to generate the file structure for a Python project that uses
@@ -68,4 +65,4 @@ To finalize the set-up for publishing to PyPi, see [here](./features/publishing.
 This project is partially based on [Audrey
 Feldroy's](https://github.com/audreyfeldroy) great
 [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) and [
-Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-pypackage).
+Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -32,10 +32,10 @@ pyenv install --list
 Select a version and install it with
 
 ``` bash
-pyenv install -v 3.9.7
+pyenv install -v 3.9.12
 ```
 
-Replacing `3.9.7` with a version of your choosing.
+Replacing `3.9.12` with a version of your choosing.
 
 ## Step 3: Generate your project
 

diff --git a/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml b/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml
@@ -6,7 +6,7 @@ inputs:
    python-version:
      required: false
      description: "The python version to use"
-     default: 3.9.7
+     default: 3.9.12
 runs:
   using: "composite"
   steps:

diff --git a/{{cookiecutter.project_name}}/Makefile b/{{cookiecutter.project_name}}/Makefile
@@ -55,6 +55,10 @@ build-and-publish: build publish ## Build and publish.
 
 {%- if cookiecutter.mkdocs == "y" %}
 
+
+docs-deploy: ## Deploy documentation to GitHub Pages
+	@mkdocs gh-deploy
+
 docs-test: ## Test if documentation can be built without warnings or errors
 	@mkdocs build -s