PythonTemplateIt 0.1.0__tar.gz → 0.2.0__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.
@@ -0,0 +1,71 @@
1
+ Metadata-Version: 2.3
2
+ Name: PythonTemplateIt
3
+ Version: 0.2.0
4
+ Summary: Template for new Python projects.
5
+ License: MIT
6
+ Author: Hendrik du Toit
7
+ Author-email: hendrik@brightedge.co.za
8
+ Maintainer: Hendrik du Toit
9
+ Maintainer-email: hendrikdt@citiqprepaid.co.za
10
+ Requires-Python: >=3.10
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Information Technology
14
+ Classifier: Intended Audience :: System Administrators
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Classifier: Topic :: System :: Archiving :: Packaging
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Project-URL: Changelog, https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/enhancement/master/ReleaseNotes.md
23
+ Project-URL: Homepage, https://github.com/BrightEdgeeServices/PythonTemplateIt
24
+ Project-URL: Repository, https://github.com/BrightEdgeeServices/PythonTemplateIt.git
25
+ Project-URL: issues, https://github.com/BrightEdgeeServices/PythonTemplateIt/issues
26
+ Description-Content-Type: text/markdown
27
+
28
+ # PythonTemplateIt
29
+
30
+ | **Category** | **Status' and Links** |
31
+ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32
+ | General | [![][general_maintenance_y_img]][general_maintenance_y_lnk] [![][general_semver_pic]][general_semver_link] [![][general_license_img]][general_license_lnk] |
33
+ | CD/CI | [![][gh_tests_img]][gh_tests_lnk] [![][cicd_codestyle_img]][cicd_codestyle_lnk] [![][cicd_pre_commit_img]][cicd_pre_commit_lnk] [![][codecov_img]][codecov_lnk] [![][gh_doc_img]][gh_doc_lnk] |
34
+ | PyPI | [![][pypi_release_img]][pypi_release_lnk] [![][pypi_py_versions_img]][pypi_py_versions_lnk] [![][pypi_format_img]][pypi_format_lnk] [![][pypi_downloads_img]][pypi_downloads_lnk] |
35
+ | Github | [![][gh_issues_img]][gh_issues_lnk] [![][gh_language_img]][gh_language_lnk] [![][gh_last_commit_img]][gh_last_commit_lnk] [![][gh_deployment_img]][gh_deployment_lnk] |
36
+
37
+ Template for Python projects.
38
+
39
+ [cicd_codestyle_img]: https://img.shields.io/badge/code%20style-black-000000.svg "Black"
40
+ [cicd_codestyle_lnk]: https://github.com/psf/black "Black"
41
+ [cicd_pre_commit_img]: https://img.shields.io/github/actions/workflow/status/hendrikdutoit/PoetryExample/pre-commit.yml?label=pre-commit "Pre-Commit"
42
+ [cicd_pre_commit_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/pre-commit.yml "Pre-Commit"
43
+ [codecov_img]: https://img.shields.io/codecov/c/gh/hendrikdutoit/PoetryExample "CodeCov"
44
+ [codecov_lnk]: https://app.codecov.io/gh/hendrikdutoit/PoetryExample "CodeCov"
45
+ [general_license_img]: https://img.shields.io/pypi/l/PythonTemplateIt "License"
46
+ [general_license_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/LICENSE "License"
47
+ [general_maintenance_y_img]: https://img.shields.io/badge/Maintenance%20Intended-%E2%9C%94-green.svg?style=flat-square "Maintenance - intended"
48
+ [general_maintenance_y_lnk]: http://unmaintained.tech/ "Maintenance - intended"
49
+ [general_semver_link]: https://semver.org/ "Sentic Versioning - 2.0.0"
50
+ [general_semver_pic]: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square "Sentic Versioning - 2.0.0"
51
+ [gh_deployment_img]: https://img.shields.io/github/deployments/hendrikdutoit/PoetryExample/pypi "GitHub - PiPy Deployment"
52
+ [gh_deployment_lnk]: https://github.com/hendrikdutoit/PoetryExample/deployments/pypi "GitHub - PiPy Deployment"
53
+ [gh_doc_img]: https://img.shields.io/readthedocs/PythonTemplateIt "Read the Docs"
54
+ [gh_doc_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/check-rst-documentation.yml "Read the Docs"
55
+ [gh_issues_img]: https://img.shields.io/github/issues-raw/hendrikdutoit/PoetryExample "GitHub - Issue Counter"
56
+ [gh_issues_lnk]: https://github.com/hendrikdutoit/PoetryExample/issues "GitHub - Issue Counter"
57
+ [gh_language_img]: https://img.shields.io/github/languages/top/hendrikdutoit/PoetryExample "GitHub - Top Language"
58
+ [gh_language_lnk]: https://github.com/hendrikdutoit/PoetryExample "GitHub - Top Language"
59
+ [gh_last_commit_img]: https://img.shields.io/github/last-commit/hendrikdutoit/PoetryExample/master "GitHub - Last Commit"
60
+ [gh_last_commit_lnk]: https://github.com/hendrikdutoit/PoetryExample/commit/master "GitHub - Last Commit"
61
+ [gh_tests_img]: https://img.shields.io/github/actions/workflow/status/hendrikdutoit/PoetryExample/ci.yml?label=ci "Test status"
62
+ [gh_tests_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/ci.yml "Test status"
63
+ [pypi_downloads_img]: https://img.shields.io/pypi/dm/PythonTemplateIt "Monthly downloads"
64
+ [pypi_downloads_lnk]: https://pypi.org/project/PythonTemplateIt/ "Monthly downloads"
65
+ [pypi_format_img]: https://img.shields.io/pypi/wheel/PythonTemplateIt "PyPI - Format"
66
+ [pypi_format_lnk]: https://pypi.org/project/PythonTemplateIt/ "PyPI - Format"
67
+ [pypi_py_versions_img]: https://img.shields.io/pypi/pyversions/PythonTemplateIt "PyPI - Supported Python Versions"
68
+ [pypi_py_versions_lnk]: https://pypi.org/project/PythonTemplateIt/ "PyPI - Supported Python Versions"
69
+ [pypi_release_img]: https://img.shields.io/pypi/v/PythonTemplateIt "Test status"
70
+ [pypi_release_lnk]: https://pypi.org/project/PythonTemplateIt/ "Test status"
71
+
@@ -0,0 +1,43 @@
1
+ # PythonTemplateIt
2
+
3
+ | **Category** | **Status' and Links** |
4
+ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5
+ | General | [![][general_maintenance_y_img]][general_maintenance_y_lnk] [![][general_semver_pic]][general_semver_link] [![][general_license_img]][general_license_lnk] |
6
+ | CD/CI | [![][gh_tests_img]][gh_tests_lnk] [![][cicd_codestyle_img]][cicd_codestyle_lnk] [![][cicd_pre_commit_img]][cicd_pre_commit_lnk] [![][codecov_img]][codecov_lnk] [![][gh_doc_img]][gh_doc_lnk] |
7
+ | PyPI | [![][pypi_release_img]][pypi_release_lnk] [![][pypi_py_versions_img]][pypi_py_versions_lnk] [![][pypi_format_img]][pypi_format_lnk] [![][pypi_downloads_img]][pypi_downloads_lnk] |
8
+ | Github | [![][gh_issues_img]][gh_issues_lnk] [![][gh_language_img]][gh_language_lnk] [![][gh_last_commit_img]][gh_last_commit_lnk] [![][gh_deployment_img]][gh_deployment_lnk] |
9
+
10
+ Template for Python projects.
11
+
12
+ [cicd_codestyle_img]: https://img.shields.io/badge/code%20style-black-000000.svg "Black"
13
+ [cicd_codestyle_lnk]: https://github.com/psf/black "Black"
14
+ [cicd_pre_commit_img]: https://img.shields.io/github/actions/workflow/status/hendrikdutoit/PoetryExample/pre-commit.yml?label=pre-commit "Pre-Commit"
15
+ [cicd_pre_commit_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/pre-commit.yml "Pre-Commit"
16
+ [codecov_img]: https://img.shields.io/codecov/c/gh/hendrikdutoit/PoetryExample "CodeCov"
17
+ [codecov_lnk]: https://app.codecov.io/gh/hendrikdutoit/PoetryExample "CodeCov"
18
+ [general_license_img]: https://img.shields.io/pypi/l/PythonTemplateIt "License"
19
+ [general_license_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/LICENSE "License"
20
+ [general_maintenance_y_img]: https://img.shields.io/badge/Maintenance%20Intended-%E2%9C%94-green.svg?style=flat-square "Maintenance - intended"
21
+ [general_maintenance_y_lnk]: http://unmaintained.tech/ "Maintenance - intended"
22
+ [general_semver_link]: https://semver.org/ "Sentic Versioning - 2.0.0"
23
+ [general_semver_pic]: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square "Sentic Versioning - 2.0.0"
24
+ [gh_deployment_img]: https://img.shields.io/github/deployments/hendrikdutoit/PoetryExample/pypi "GitHub - PiPy Deployment"
25
+ [gh_deployment_lnk]: https://github.com/hendrikdutoit/PoetryExample/deployments/pypi "GitHub - PiPy Deployment"
26
+ [gh_doc_img]: https://img.shields.io/readthedocs/PythonTemplateIt "Read the Docs"
27
+ [gh_doc_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/check-rst-documentation.yml "Read the Docs"
28
+ [gh_issues_img]: https://img.shields.io/github/issues-raw/hendrikdutoit/PoetryExample "GitHub - Issue Counter"
29
+ [gh_issues_lnk]: https://github.com/hendrikdutoit/PoetryExample/issues "GitHub - Issue Counter"
30
+ [gh_language_img]: https://img.shields.io/github/languages/top/hendrikdutoit/PoetryExample "GitHub - Top Language"
31
+ [gh_language_lnk]: https://github.com/hendrikdutoit/PoetryExample "GitHub - Top Language"
32
+ [gh_last_commit_img]: https://img.shields.io/github/last-commit/hendrikdutoit/PoetryExample/master "GitHub - Last Commit"
33
+ [gh_last_commit_lnk]: https://github.com/hendrikdutoit/PoetryExample/commit/master "GitHub - Last Commit"
34
+ [gh_tests_img]: https://img.shields.io/github/actions/workflow/status/hendrikdutoit/PoetryExample/ci.yml?label=ci "Test status"
35
+ [gh_tests_lnk]: https://github.com/hendrikdutoit/PoetryExample/blob/master/.github/workflows/ci.yml "Test status"
36
+ [pypi_downloads_img]: https://img.shields.io/pypi/dm/PythonTemplateIt "Monthly downloads"
37
+ [pypi_downloads_lnk]: https://pypi.org/project/PythonTemplateIt/ "Monthly downloads"
38
+ [pypi_format_img]: https://img.shields.io/pypi/wheel/PythonTemplateIt "PyPI - Format"
39
+ [pypi_format_lnk]: https://pypi.org/project/PythonTemplateIt/ "PyPI - Format"
40
+ [pypi_py_versions_img]: https://img.shields.io/pypi/pyversions/PythonTemplateIt "PyPI - Supported Python Versions"
41
+ [pypi_py_versions_lnk]: https://pypi.org/project/PythonTemplateIt/ "PyPI - Supported Python Versions"
42
+ [pypi_release_img]: https://img.shields.io/pypi/v/PythonTemplateIt "Test status"
43
+ [pypi_release_lnk]: https://pypi.org/project/PythonTemplateIt/ "Test status"
@@ -0,0 +1,117 @@
1
+ [build-system]
2
+ requires = [
3
+ "poetry-core>=2.0.0,<3.0.0",
4
+ ]
5
+ build-backend = "poetry.core.masonry.api"
6
+
7
+ [project]
8
+ name = 'PythonTemplateIt'
9
+ version = '0.2.0'
10
+ description = 'Template for new Python projects.'
11
+
12
+ authors = [
13
+ { name = 'Hendrik du Toit', email = 'hendrik@brightedge.co.za' },
14
+ ]
15
+ classifiers = [
16
+ "Development Status :: 4 - Beta",
17
+ "Intended Audience :: Developers",
18
+ "Intended Audience :: Information Technology",
19
+ "Intended Audience :: System Administrators",
20
+ 'License :: OSI Approved :: MIT License',
21
+ "Topic :: Software Development :: Libraries :: Python Modules",
22
+ "Topic :: System :: Archiving :: Packaging",
23
+ 'Programming Language :: Python :: 3.10',
24
+ 'Programming Language :: Python :: 3.11',
25
+ 'Programming Language :: Python :: 3.12',
26
+ 'Programming Language :: Python :: 3.13',
27
+ ]
28
+ dependencies = [
29
+ ]
30
+ license = "MIT"
31
+ maintainers = [
32
+ { name = "Hendrik du Toit", email = "hendrikdt@citiqprepaid.co.za" },
33
+ { name = 'Henru du Toit', email = 'henru@brightedge.co.za' },
34
+ { name = 'Dirk du Toit', email = 'dirk@brightedge.co.za' },
35
+ ]
36
+ readme = { file = 'README.md', content-type = 'text/markdown' }
37
+ #readme = "README.md"
38
+ requires-python = ">=3.10"
39
+
40
+ [project.urls]
41
+ # documentation = "https://readthedocs.org"
42
+ issues = "https://github.com/BrightEdgeeServices/PythonTemplateIt/issues"
43
+ Changelog = 'https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/enhancement/master/ReleaseNotes.md'
44
+ Homepage = 'https://github.com/BrightEdgeeServices/PythonTemplateIt'
45
+ repository = "https://github.com/BrightEdgeeServices/PythonTemplateIt.git"
46
+
47
+ [tool.black]
48
+ line-length = 120
49
+ #skip-string-normalization = true
50
+ target-version = [
51
+ "py313",
52
+ ]
53
+ extend-exclude = '''
54
+ (
55
+ ^tests/testdata.py
56
+ )
57
+ '''
58
+
59
+ [tool.codespell]
60
+ count = ''
61
+ quiet-level = 2
62
+ skip = 'documentation/Archive/*'
63
+ ignore-words-list = 'space-holder'
64
+ write-changes = ''
65
+
66
+ [tool.coverage.run]
67
+ source = [
68
+ 'src',
69
+ 'tests',
70
+ ]
71
+
72
+ [tool.isort]
73
+ profile = "black"
74
+
75
+ [tool.poetry.dependencies]
76
+
77
+ [tool.poetry.group.dev]
78
+ optional = true
79
+
80
+ [tool.poetry.group.dev.dependencies]
81
+ black = ">=25.1.0"
82
+ codecov = ">=2.1.13"
83
+ flake8 = ">=7.1.1"
84
+ mdformat-gfm = ">=0.4.1"
85
+ mdformat-frontmatter = ">=2.0.8"
86
+ mdformat-footnote = ">=0.1.1"
87
+ pre-commit = ">=4.0.1"
88
+ pytest = ">=8.3.4"
89
+ pytest-cov = ">=6.0.0"
90
+ rstcheck = { extras = [
91
+ "sphinx",
92
+ ], version = ">=6.2.4" }
93
+ sphinx = ">=8.1.3"
94
+ twine = ">=6.1.0"
95
+
96
+
97
+ [[tool.poetry.source]]
98
+ name = "PoetryPrivate"
99
+ url = "https://github.com/BrightEdgeeServices/PoetryPrivate.git"
100
+ priority = "supplemental"
101
+
102
+ [tool.pytest.ini_options]
103
+ addopts = [
104
+ '-vv',
105
+ '--ignore-glob=*\\Archive',
106
+ ]
107
+ filterwarnings = [
108
+ # "ignore::DeprecationWarning",
109
+ ]
110
+ pythonpath = [
111
+ 'src',
112
+ 'tests',
113
+ ]
114
+ testpaths = 'tests'
115
+ markers = [
116
+ "select: Run a selection of tests",
117
+ ]
@@ -1,3 +1,3 @@
1
- class MyClass:
2
- def __init__(self, status):
3
- self.status = status
1
+ class MyClass:
2
+ def __init__(self, status):
3
+ self.status = status
@@ -1,127 +0,0 @@
1
- Metadata-Version: 2.3
2
- Name: PythonTemplateIt
3
- Version: 0.1.0
4
- Summary: Template for new Python projects.
5
- License: MIT
6
- Author: Hendrik du Toit
7
- Author-email: hendrik@brightedge.co.za
8
- Maintainer: Hendrik du Toit
9
- Maintainer-email: hendrikdt@citiqprepaid.co.za
10
- Requires-Python: >=3.10
11
- Classifier: Development Status :: 4 - Beta
12
- Classifier: Intended Audience :: Developers
13
- Classifier: Intended Audience :: Information Technology
14
- Classifier: Intended Audience :: System Administrators
15
- Classifier: License :: OSI Approved :: MIT License
16
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
- Classifier: Topic :: System :: Archiving :: Packaging
18
- Classifier: Programming Language :: Python :: 3.10
19
- Classifier: Programming Language :: Python :: 3.11
20
- Classifier: Programming Language :: Python :: 3.12
21
- Project-URL: Changelog, https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/enhancement/master/ReleaseNotes.md
22
- Project-URL: Homepage, https://github.com/BrightEdgeeServices/PythonTemplateIt
23
- Project-URL: Repository, https://github.com/BrightEdgeeServices/PythonTemplateIt.git
24
- Project-URL: issues, https://github.com/BrightEdgeeServices/PythonTemplateIt/issues
25
- Description-Content-Type: text/x-rst
26
-
27
- ================
28
- PythonTemplateIt
29
- ================
30
-
31
- +-----------+------------------------------------------------------------------------------------+
32
- |**General**| |maintenance_y| |semver| |license| |
33
- +-----------+------------------------------------------------------------------------------------+
34
- |**CD/CI** | |codestyle| |codecov| |
35
- +-----------+------------------------------------------------------------------------------------+
36
- |**PyPI** | |pypi_release| |pypi_py_versions| |pypi_status| |pypi_format| |pypi_downloads| |
37
- +-----------+------------------------------------------------------------------------------------+
38
- |**Github** | |gh_issues| |gh_language| |gh_last_commit| |
39
- +-----------+------------------------------------------------------------------------------------+
40
-
41
-
42
- Python repository template.
43
-
44
-
45
- .. General
46
-
47
- .. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square
48
- :target: http://unmaintained.tech/
49
- :alt: Maintenance - not intended
50
-
51
- .. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square
52
- :target: http://unmaintained.tech/
53
- :alt: Maintenance - intended
54
-
55
- .. |license| image:: https://img.shields.io/pypi/l/PythonTemplateIt
56
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/LICENSE
57
- :alt: License
58
-
59
- .. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square
60
- :target: https://semver.org/
61
- :alt: Semantic Versioning - 2.0.0
62
-
63
-
64
- .. CI
65
-
66
- .. |codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
67
- :target: https://github.com/psf/black
68
- :alt: Code Style Black
69
-
70
- .. |pre_commit_ci| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/PythonTemplateIt/pre-commit.yml?label=pre-commit
71
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/pre-commit.yml
72
- :alt: Pre-Commit
73
-
74
- .. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/PythonTemplateIt/ci.yml?label=ci
75
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/ci.yml
76
- :alt: Test status
77
-
78
- .. |gha_docu| image:: https://img.shields.io/readthedocs/PythonTemplateIt
79
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/check-rst-documentation.yml
80
- :alt: Read the Docs
81
-
82
- .. |codecov| image:: https://img.shields.io/codecov/c/gh/BrightEdgeeServices/PythonTemplateIt
83
- :target: https://app.codecov.io/gh/BrightEdgeeServices/PythonTemplateIt
84
- :alt: CodeCov
85
-
86
-
87
- .. PyPI
88
-
89
- .. |pypi_release| image:: https://img.shields.io/pypi/v/PythonTemplateIt
90
- :target: https://pypi.org/project/PythonTemplateIt/
91
- :alt: PyPI - Package latest release
92
-
93
- .. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/PythonTemplateIt
94
- :target: https://pypi.org/project/PythonTemplateIt/
95
- :alt: PyPI - Supported Python Versions
96
-
97
- .. |pypi_format| image:: https://img.shields.io/pypi/wheel/PythonTemplateIt
98
- :target: https://pypi.org/project/PythonTemplateIt/
99
- :alt: PyPI - Format
100
-
101
- .. |pypi_downloads| image:: https://img.shields.io/pypi/dm/PythonTemplateIt
102
- :target: https://pypi.org/project/PythonTemplateIt/
103
- :alt: PyPI - Monthly downloads
104
-
105
- .. |pypi_status| image:: https://img.shields.io/pypi/status/PythonTemplateIt
106
- :target: https://pypi.org/project/PythonTemplateIt/
107
- :alt: PyPI - Status
108
-
109
-
110
- .. GitHub
111
-
112
- .. |gh_issues| image:: https://img.shields.io/github/issues-raw/BrightEdgeeServices/PythonTemplateIt
113
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/issues
114
- :alt: GitHub - Issue Counter
115
-
116
- .. |gh_language| image:: https://img.shields.io/github/languages/top/BrightEdgeeServices/PythonTemplateIt
117
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt
118
- :alt: GitHub - Top Language
119
-
120
- .. |gh_last_commit| image:: https://img.shields.io/github/last-commit/BrightEdgeeServices/PythonTemplateIt/master
121
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/commit/master
122
- :alt: GitHub - Last Commit
123
-
124
- .. |gh_deployment| image:: https://img.shields.io/github/deployments/BrightEdgeeServices/PythonTemplateIt/pypi
125
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/deployments/pypi
126
- :alt: GitHub - PiPy Deployment
127
-
@@ -1,100 +0,0 @@
1
- ================
2
- PythonTemplateIt
3
- ================
4
-
5
- +-----------+------------------------------------------------------------------------------------+
6
- |**General**| |maintenance_y| |semver| |license| |
7
- +-----------+------------------------------------------------------------------------------------+
8
- |**CD/CI** | |codestyle| |codecov| |
9
- +-----------+------------------------------------------------------------------------------------+
10
- |**PyPI** | |pypi_release| |pypi_py_versions| |pypi_status| |pypi_format| |pypi_downloads| |
11
- +-----------+------------------------------------------------------------------------------------+
12
- |**Github** | |gh_issues| |gh_language| |gh_last_commit| |
13
- +-----------+------------------------------------------------------------------------------------+
14
-
15
-
16
- Python repository template.
17
-
18
-
19
- .. General
20
-
21
- .. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square
22
- :target: http://unmaintained.tech/
23
- :alt: Maintenance - not intended
24
-
25
- .. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square
26
- :target: http://unmaintained.tech/
27
- :alt: Maintenance - intended
28
-
29
- .. |license| image:: https://img.shields.io/pypi/l/PythonTemplateIt
30
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/LICENSE
31
- :alt: License
32
-
33
- .. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square
34
- :target: https://semver.org/
35
- :alt: Semantic Versioning - 2.0.0
36
-
37
-
38
- .. CI
39
-
40
- .. |codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
41
- :target: https://github.com/psf/black
42
- :alt: Code Style Black
43
-
44
- .. |pre_commit_ci| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/PythonTemplateIt/pre-commit.yml?label=pre-commit
45
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/pre-commit.yml
46
- :alt: Pre-Commit
47
-
48
- .. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/PythonTemplateIt/ci.yml?label=ci
49
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/ci.yml
50
- :alt: Test status
51
-
52
- .. |gha_docu| image:: https://img.shields.io/readthedocs/PythonTemplateIt
53
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/master/.github/workflows/check-rst-documentation.yml
54
- :alt: Read the Docs
55
-
56
- .. |codecov| image:: https://img.shields.io/codecov/c/gh/BrightEdgeeServices/PythonTemplateIt
57
- :target: https://app.codecov.io/gh/BrightEdgeeServices/PythonTemplateIt
58
- :alt: CodeCov
59
-
60
-
61
- .. PyPI
62
-
63
- .. |pypi_release| image:: https://img.shields.io/pypi/v/PythonTemplateIt
64
- :target: https://pypi.org/project/PythonTemplateIt/
65
- :alt: PyPI - Package latest release
66
-
67
- .. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/PythonTemplateIt
68
- :target: https://pypi.org/project/PythonTemplateIt/
69
- :alt: PyPI - Supported Python Versions
70
-
71
- .. |pypi_format| image:: https://img.shields.io/pypi/wheel/PythonTemplateIt
72
- :target: https://pypi.org/project/PythonTemplateIt/
73
- :alt: PyPI - Format
74
-
75
- .. |pypi_downloads| image:: https://img.shields.io/pypi/dm/PythonTemplateIt
76
- :target: https://pypi.org/project/PythonTemplateIt/
77
- :alt: PyPI - Monthly downloads
78
-
79
- .. |pypi_status| image:: https://img.shields.io/pypi/status/PythonTemplateIt
80
- :target: https://pypi.org/project/PythonTemplateIt/
81
- :alt: PyPI - Status
82
-
83
-
84
- .. GitHub
85
-
86
- .. |gh_issues| image:: https://img.shields.io/github/issues-raw/BrightEdgeeServices/PythonTemplateIt
87
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/issues
88
- :alt: GitHub - Issue Counter
89
-
90
- .. |gh_language| image:: https://img.shields.io/github/languages/top/BrightEdgeeServices/PythonTemplateIt
91
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt
92
- :alt: GitHub - Top Language
93
-
94
- .. |gh_last_commit| image:: https://img.shields.io/github/last-commit/BrightEdgeeServices/PythonTemplateIt/master
95
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/commit/master
96
- :alt: GitHub - Last Commit
97
-
98
- .. |gh_deployment| image:: https://img.shields.io/github/deployments/BrightEdgeeServices/PythonTemplateIt/pypi
99
- :target: https://github.com/BrightEdgeeServices/PythonTemplateIt/deployments/pypi
100
- :alt: GitHub - PiPy Deployment
@@ -1,105 +0,0 @@
1
- [build-system]
2
- requires = ["poetry-core>=2.0.0,<3.0.0"]
3
- build-backend = "poetry.core.masonry.api"
4
-
5
- [project]
6
- name = 'PythonTemplateIt'
7
- version = '0.1.0'
8
- description = 'Template for new Python projects.'
9
-
10
- authors = [
11
- { name = 'Hendrik du Toit', email = 'hendrik@brightedge.co.za' },
12
- ]
13
- maintainers = [
14
- { name = "Hendrik du Toit", email = "hendrikdt@citiqprepaid.co.za" },
15
- { name = 'Henru du Toit', email = 'henru@brightedge.co.za' },
16
- { name = 'Dirk du Toit', email = 'dirk@brightedge.co.za' },
17
- ]
18
- license = "MIT"
19
- readme = "README.rst"
20
- classifiers = [
21
- "Development Status :: 4 - Beta",
22
- "Intended Audience :: Developers",
23
- "Intended Audience :: Information Technology",
24
- "Intended Audience :: System Administrators",
25
- 'License :: OSI Approved :: MIT License',
26
- "Topic :: Software Development :: Libraries :: Python Modules",
27
- "Topic :: System :: Archiving :: Packaging",
28
- 'Programming Language :: Python :: 3.10',
29
- 'Programming Language :: Python :: 3.11',
30
- 'Programming Language :: Python :: 3.12'
31
- ]
32
- # documentation = "https://readthedocs.org"
33
- dependencies = []
34
- requires-python = ">=3.10"
35
-
36
- [project.urls]
37
- issues = "https://github.com/BrightEdgeeServices/PythonTemplateIt/issues"
38
- Changelog = 'https://github.com/BrightEdgeeServices/PythonTemplateIt/blob/enhancement/master/ReleaseNotes.md'
39
- Homepage = 'https://github.com/BrightEdgeeServices/PythonTemplateIt'
40
- repository = "https://github.com/BrightEdgeeServices/PythonTemplateIt.git"
41
-
42
- [tool.black]
43
- line-length = 120
44
- #skip-string-normalization = true
45
- target-version = [
46
- "py313",
47
- ]
48
- extend-exclude = '''
49
- (
50
- ^tests/testdata.py
51
- )
52
- '''
53
-
54
- [tool.codespell]
55
- count = ''
56
- quiet-level = 2
57
- skip = 'documentation/Archive/*'
58
- ignore-words-list = 'space-holder'
59
- write-changes = ''
60
-
61
- [tool.coverage.run]
62
- source = [
63
- 'src',
64
- 'tests',
65
- ]
66
-
67
- [tool.isort]
68
- profile = "black"
69
-
70
- [tool.poetry.dependencies]
71
-
72
-
73
- [tool.poetry.group.dev]
74
- optional = true
75
-
76
- [tool.poetry.group.dev.dependencies]
77
- black = ">=24.10.0"
78
- codecov = ">=2.1.13"
79
- flake8 = ">=7.1.1"
80
- mdformat-gfm = ">=0.4.1"
81
- mdformat-frontmatter = ">=2.0.8"
82
- mdformat-footnote = ">=0.1.1"
83
- pre-commit = ">=4.0.1"
84
- pytest = ">=8.3.4"
85
- pytest-cov = ">=6.0.0"
86
- rstcheck = { extras = ["sphinx"], version = ">=6.2.4" }
87
- sphinx = ">=8.1.3"
88
- twine = "^6.0.1"
89
-
90
- [tool.pytest.ini_options]
91
- addopts = [
92
- '-vv',
93
- '--ignore-glob=*\\Archive',
94
- ]
95
- filterwarnings = [
96
- # "ignore::DeprecationWarning",
97
- ]
98
- pythonpath = [
99
- 'src',
100
- 'tests',
101
- ]
102
- testpaths = 'tests'
103
- markers = [
104
- "select: Run a selection of tests",
105
- ]