python-package-template-pypi 0.0.1__tar.gz → 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/PKG-INFO +21 -12
  2. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/README.md +20 -11
  3. python_package_template_pypi-0.0.2/docs/_static/.gitkeep +0 -0
  4. python_package_template_pypi-0.0.2/docs/add_five.rst +19 -0
  5. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/pyproject.toml +1 -1
  6. python_package_template_pypi-0.0.1/docs/add_five.rst +0 -6
  7. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.github/CODEOWNERS +0 -0
  8. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
  9. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.github/workflows/ci.yml +0 -0
  10. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.github/workflows/release.yml +0 -0
  11. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.gitignore +0 -0
  12. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/.pre-commit-config.yaml +0 -0
  13. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/LICENSE +0 -0
  14. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/docs/conf.py +0 -0
  15. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/docs/index.rst +0 -0
  16. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/readthedocs.yml +0 -0
  17. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/src/python_package_template/__init__.py +0 -0
  18. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/src/python_package_template/main.py +0 -0
  19. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/tests/__init__.py +0 -0
  20. {python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/tests/main_test.py +0 -0
{python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: python-package-template-pypi
3
- Version: 0.0.1
3
+ Version: 0.0.2
4
4
  Summary: A github template with my python package configurations.
5
5
  Project-URL: Repository, https://github.com/daniel-mizsak/python-package-template
6
6
  Author-email: Daniel Mizsak <info@pythonvilag.hu>
@@ -48,8 +48,8 @@ Description-Content-Type: text/markdown
48
48
  <div align="center">
49
49
  <a href="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
50
50
  <a href="https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main" target="_blank"><img src="https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg" alt="pre-commit.ci status"></a>
51
- <a href='https://daniel-mizsak-python-package-template.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/daniel-mizsak-python-package-template/badge/?version=latest' alt='docs status' /></a>
52
- <a href="ttps://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
51
+ <a href='https://python-package-template-pypi.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/python-package-template-pypi/badge/?version=latest' alt='docs status' /></a>
52
+ <a href="https://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
53
53
  </div>
54
54
 
55
55
 
@@ -57,27 +57,37 @@ Description-Content-Type: text/markdown
57
57
  A GitHub template with my python package configurations.
58
58
 
59
59
  ## GitHub repository settings
60
+ The following settings are enabled in my repository settings:
61
+
60
62
  Code/About:
61
63
  - Releases
62
64
 
65
+ <br>
66
+
63
67
  General/Features:
64
68
  - Issues
65
69
  - Preserve this repository
66
70
 
71
+ <br>
72
+
67
73
  General/Pull Requests:
68
74
  - Allow merge commits
69
75
  - Allow squash merging
70
76
  - Allow rebase merging
71
77
  - Automatically delete head branches
72
78
 
79
+ <br>
80
+
73
81
  Branches/Branch protection rules:\
74
- `main`
75
- - Protect matching branches
76
- - Require pull request reviews before merging
77
- - Dismiss stale pull request approvals when new commits are pushed
78
- - Require status checks to pass before merging
79
- - `pre-commit.ci - pr`
80
- - `tox / tox`
82
+ `main`\
83
+ Protect matching branches
84
+ - Require pull request reviews before merging
85
+ - Dismiss stale pull request approvals when new commits are pushed
86
+ - Require status checks to pass before merging
87
+ - `pre-commit.ci - pr`
88
+ - `tox / tox`
89
+
90
+ <br>
81
91
 
82
92
  Environments:\
83
93
  `pypi`
@@ -87,11 +97,10 @@ Environments:\
87
97
  - Allow administrators to bypass configured protection rules
88
98
 
89
99
  ## Setup PyPi trusted publishing
90
-
91
100
  [PyPi publishing settings](https://pypi.org/manage/account/publishing/)
92
101
 
93
102
  Add a new pending publisher:
94
103
  - PyPi Project Name: `python-package-template-pypi` (has to match the project name in `pyproject.toml`)
95
104
  - Owner: `daniel-mizsak`
96
- - Repository name: `https://github.com/daniel-mizsak/python-package-template`
105
+ - Repository name: `python-package-template`
97
106
  - Workflow name: `release.yml`
{python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/README.md RENAMED
@@ -3,8 +3,8 @@
3
3
  <div align="center">
4
4
  <a href="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
5
5
  <a href="https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main" target="_blank"><img src="https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg" alt="pre-commit.ci status"></a>
6
- <a href='https://daniel-mizsak-python-package-template.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/daniel-mizsak-python-package-template/badge/?version=latest' alt='docs status' /></a>
7
- <a href="ttps://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
6
+ <a href='https://python-package-template-pypi.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/python-package-template-pypi/badge/?version=latest' alt='docs status' /></a>
7
+ <a href="https://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
8
8
  </div>
9
9
 
10
10
 
@@ -12,27 +12,37 @@
12
12
  A GitHub template with my python package configurations.
13
13
 
14
14
  ## GitHub repository settings
15
+ The following settings are enabled in my repository settings:
16
+
15
17
  Code/About:
16
18
  - Releases
17
19
 
20
+ <br>
21
+
18
22
  General/Features:
19
23
  - Issues
20
24
  - Preserve this repository
21
25
 
26
+ <br>
27
+
22
28
  General/Pull Requests:
23
29
  - Allow merge commits
24
30
  - Allow squash merging
25
31
  - Allow rebase merging
26
32
  - Automatically delete head branches
27
33
 
34
+ <br>
35
+
28
36
  Branches/Branch protection rules:\
29
- `main`
30
- - Protect matching branches
31
- - Require pull request reviews before merging
32
- - Dismiss stale pull request approvals when new commits are pushed
33
- - Require status checks to pass before merging
34
- - `pre-commit.ci - pr`
35
- - `tox / tox`
37
+ `main`\
38
+ Protect matching branches
39
+ - Require pull request reviews before merging
40
+ - Dismiss stale pull request approvals when new commits are pushed
41
+ - Require status checks to pass before merging
42
+ - `pre-commit.ci - pr`
43
+ - `tox / tox`
44
+
45
+ <br>
36
46
 
37
47
  Environments:\
38
48
  `pypi`
@@ -42,11 +52,10 @@ Environments:\
42
52
  - Allow administrators to bypass configured protection rules
43
53
 
44
54
  ## Setup PyPi trusted publishing
45
-
46
55
  [PyPi publishing settings](https://pypi.org/manage/account/publishing/)
47
56
 
48
57
  Add a new pending publisher:
49
58
  - PyPi Project Name: `python-package-template-pypi` (has to match the project name in `pyproject.toml`)
50
59
  - Owner: `daniel-mizsak`
51
- - Repository name: `https://github.com/daniel-mizsak/python-package-template`
60
+ - Repository name: `python-package-template`
52
61
  - Workflow name: `release.yml`
python_package_template_pypi-0.0.2/docs/add_five.rst ADDED
@@ -0,0 +1,19 @@
1
+ Add five
2
+ ========
3
+
4
+ Example call
5
+ ------------
6
+
7
+ To increment the value of a number by five, use the `add_five` function.
8
+
9
+ .. code-block:: python
10
+
11
+ from python_package_template import add_five
12
+
13
+ print(add_five(8))
14
+
15
+
16
+ Description of the `add_five` function:
17
+ ---------------------------------------
18
+
19
+ .. autofunction:: python_package_template.main.add_five
{python_package_template_pypi-0.0.1 → python_package_template_pypi-0.0.2}/pyproject.toml RENAMED
@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
6
6
  # Project Metadata
7
7
  [project]
8
8
  name = "python-package-template-pypi" # Name has to be unique on pypi.
9
- version = "0.0.1"
9
+ version = "0.0.2"
10
10
  description = "A github template with my python package configurations."
11
11
  readme = "README.md"
12
12
  requires-python = ">=3.12"
python_package_template_pypi-0.0.1/docs/add_five.rst DELETED
@@ -1,6 +0,0 @@
1
- Add five
2
- ========
3
-
4
- Description of the `add_five` function:
5
-
6
- .. autofunction:: python_package_template.main.add_five