Skip to content

Commit 5858f99

Browse files
authored
Merge pull request #2 from xdurana/change-python-version
2 parents 2281873 + 31ef419 commit 5858f99

7 files changed

Lines changed: 13 additions & 14 deletions

File tree

.github/actions/setup-poetry-env/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ inputs:
66
python-version:
77
required: false
88
description: "The python version to use"
9-
default: 3.9.7
9+
default: 3.9.12
1010
runs:
1111
using: "composite"
1212
steps:

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PYTHON_VERSION := 3.9.7
1+
PYTHON_VERSION := 3.9.12
22

33
bake: ## bake without inputs and overwrite if exists.
44
@cookiecutter --no-input . --overwrite-if-exists

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Cookiecutter PyPackage
22

3-
[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
3+
[![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/)
44
[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://xdurana.github.io/cookiecutter-pypackage/)
5-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/cookiecutter-pypackage)](https://img.shields.io/pypi/dm/cookiecutter-pypackage?style=flat-square)
65

76
This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
87
repository to generate the file structure for a Python project that uses
98
[Poetry](https://python-poetry.org/) for its dependency management.
109

1110
- **Documentation**: [Link](https://xdurana.github.io/cookiecutter-pypackage/)
1211
- **Example repository**: [Link](https://github.com/xdurana/cookiecutter-pypackage-example)
13-
- **PyPi**: [Link](https://pypi.org/project/cookiecutter-pypackage/)
1412

1513
## Features
1614

@@ -73,4 +71,4 @@ For activating the automatic documentation with MkDocs, see
7371
This project is partially based on [Audrey
7472
Feldroy's](https://github.com/audreyfeldroy) great
7573
[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) and [
76-
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-pypackage).
74+
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

docs/index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11

22
# Cookiecutter PyPackage
33

4-
[![Release](https://img.shields.io/github/v/release/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
5-
[![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)
6-
[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-pypackage)](https://pypi.org/project/cookiecutter-pypackage/)
7-
[![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)
4+
[![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/)
85

96
This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
107
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.
6865
This project is partially based on [Audrey
6966
Feldroy's](https://github.com/audreyfeldroy) great
7067
[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) and [
71-
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-pypackage).
68+
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

docs/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ pyenv install --list
3232
Select a version and install it with
3333

3434
``` bash
35-
pyenv install -v 3.9.7
35+
pyenv install -v 3.9.12
3636
```
3737

38-
Replacing `3.9.7` with a version of your choosing.
38+
Replacing `3.9.12` with a version of your choosing.
3939

4040
## Step 3: Generate your project
4141

{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ inputs:
66
python-version:
77
required: false
88
description: "The python version to use"
9-
default: 3.9.7
9+
default: 3.9.12
1010
runs:
1111
using: "composite"
1212
steps:

{{cookiecutter.project_name}}/Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ build-and-publish: build publish ## Build and publish.
5555

5656
{%- if cookiecutter.mkdocs == "y" %}
5757

58+
59+
docs-deploy: ## Deploy documentation to GitHub Pages
60+
@mkdocs gh-deploy
61+
5862
docs-test: ## Test if documentation can be built without warnings or errors
5963
@mkdocs build -s
6064

0 commit comments

Comments
 (0)