dbrownell-toolsdirectory 0.1.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.
Files changed (6) hide show
  1. dbrownell_toolsdirectory-0.1.0/PKG-INFO +75 -0
  2. dbrownell_toolsdirectory-0.1.0/README.md +57 -0
  3. dbrownell_toolsdirectory-0.1.0/pyproject.toml +89 -0
  4. dbrownell_toolsdirectory-0.1.0/src/dbrownell_ToolsDirectory/UvScaffolding_sample_file.py +11 -0
  5. dbrownell_toolsdirectory-0.1.0/src/dbrownell_ToolsDirectory/__init__.py +6 -0
  6. dbrownell_toolsdirectory-0.1.0/src/dbrownell_ToolsDirectory/py.typed +0 -0
dbrownell_toolsdirectory-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,75 @@
1
+ Metadata-Version: 2.3
2
+ Name: dbrownell-toolsdirectory
3
+ Version: 0.1.0
4
+ Summary: Creates functionality to manipulate the shell in support of tools defined within a tools directory.
5
+ Author: David Brownell
6
+ Author-email: David Brownell <github@DavidBrownell.com>
7
+ License: MIT
8
+ Classifier: Operating System :: MacOS
9
+ Classifier: Operating System :: Microsoft :: Windows
10
+ Classifier: Operating System :: POSIX :: Linux
11
+ Classifier: Programming Language :: Python
12
+ Classifier: Programming Language :: Python :: 3.14
13
+ Requires-Python: >=3.14
14
+ Project-URL: Documentation, https://github.com/davidbrownell/dbrownell_ToolsDirectory
15
+ Project-URL: Homepage, https://github.com/davidbrownell/dbrownell_ToolsDirectory
16
+ Project-URL: Repository, https://github.com/davidbrownell/dbrownell_ToolsDirectory
17
+ Description-Content-Type: text/markdown
18
+
19
+ **Project:**
20
+ [![License](https://img.shields.io/github/license/davidbrownell/dbrownell_ToolsDirectory?color=dark-green)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/master/LICENSE)
21
+
22
+ **Package:**
23
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dbrownell_ToolsDirectory?color=dark-green)](https://pypi.org/project/dbrownell_ToolsDirectory/)
24
+ [![PyPI - Version](https://img.shields.io/pypi/v/dbrownell_ToolsDirectory?color=dark-green)](https://pypi.org/project/dbrownell_ToolsDirectory/)
25
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/dbrownell_ToolsDirectory)](https://pypistats.org/packages/dbrownell-toolsdirectory)
26
+
27
+ **Development:**
28
+ [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
29
+ [![CI](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions/workflows/CICD.yml/badge.svg)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions/workflows/CICD.yml)
30
+ [![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/davidbrownell/f15146b1b8fdc0a5d45ac0eb786a84f7/raw/dbrownell_ToolsDirectory_code_coverage.json)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions)
31
+ [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/davidbrownell/dbrownell_ToolsDirectory?color=dark-green)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/commits/main/)
32
+
33
+ <!-- Content above this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
34
+
35
+ ## Contents
36
+ - [Overview](#overview)
37
+ - [Installation](#installation)
38
+ - [Development](#development)
39
+ - [Additional Information](#additional-information)
40
+ - [License](#license)
41
+
42
+ ## Overview
43
+ TODO: Complete this section
44
+
45
+ ### How to use `dbrownell_ToolsDirectory`
46
+ TODO: Complete this section
47
+
48
+ <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
49
+
50
+ ## Installation
51
+
52
+ | Installation Method | Command |
53
+ | --- | --- |
54
+ | Via [uv](https://github.com/astral-sh/uv) | `uv add dbrownell_ToolsDirectory` |
55
+ | Via [pip](https://pip.pypa.io/en/stable/) | `pip install dbrownell_ToolsDirectory` |
56
+
57
+
58
+
59
+ ## Development
60
+ Please visit [Contributing](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/DEVELOPMENT.md) for information on contributing to this project.
61
+
62
+ ## Additional Information
63
+ Additional information can be found at these locations.
64
+
65
+ | Title | Document | Description |
66
+ | --- | --- | --- |
67
+ | Code of Conduct | [CODE_OF_CONDUCT.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CODE_OF_CONDUCT.md) | Information about the norms, rules, and responsibilities we adhere to when participating in this open source community. |
68
+ | Contributing | [CONTRIBUTING.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CONTRIBUTING.md) | Information about contributing to this project. |
69
+ | Development | [DEVELOPMENT.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. |
70
+ | Governance | [GOVERNANCE.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/GOVERNANCE.md) | Information about how this project is governed. |
71
+ | Maintainers | [MAINTAINERS.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/MAINTAINERS.md) | Information about individuals who maintain this project. |
72
+ | Security | [SECURITY.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
73
+
74
+ ## License
75
+ `dbrownell_ToolsDirectory` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
dbrownell_toolsdirectory-0.1.0/README.md ADDED
@@ -0,0 +1,57 @@
1
+ **Project:**
2
+ [![License](https://img.shields.io/github/license/davidbrownell/dbrownell_ToolsDirectory?color=dark-green)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/master/LICENSE)
3
+
4
+ **Package:**
5
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dbrownell_ToolsDirectory?color=dark-green)](https://pypi.org/project/dbrownell_ToolsDirectory/)
6
+ [![PyPI - Version](https://img.shields.io/pypi/v/dbrownell_ToolsDirectory?color=dark-green)](https://pypi.org/project/dbrownell_ToolsDirectory/)
7
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/dbrownell_ToolsDirectory)](https://pypistats.org/packages/dbrownell-toolsdirectory)
8
+
9
+ **Development:**
10
+ [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
11
+ [![CI](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions/workflows/CICD.yml/badge.svg)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions/workflows/CICD.yml)
12
+ [![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/davidbrownell/f15146b1b8fdc0a5d45ac0eb786a84f7/raw/dbrownell_ToolsDirectory_code_coverage.json)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/actions)
13
+ [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/davidbrownell/dbrownell_ToolsDirectory?color=dark-green)](https://github.com/davidbrownell/dbrownell_ToolsDirectory/commits/main/)
14
+
15
+ <!-- Content above this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
16
+
17
+ ## Contents
18
+ - [Overview](#overview)
19
+ - [Installation](#installation)
20
+ - [Development](#development)
21
+ - [Additional Information](#additional-information)
22
+ - [License](#license)
23
+
24
+ ## Overview
25
+ TODO: Complete this section
26
+
27
+ ### How to use `dbrownell_ToolsDirectory`
28
+ TODO: Complete this section
29
+
30
+ <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
31
+
32
+ ## Installation
33
+
34
+ | Installation Method | Command |
35
+ | --- | --- |
36
+ | Via [uv](https://github.com/astral-sh/uv) | `uv add dbrownell_ToolsDirectory` |
37
+ | Via [pip](https://pip.pypa.io/en/stable/) | `pip install dbrownell_ToolsDirectory` |
38
+
39
+
40
+
41
+ ## Development
42
+ Please visit [Contributing](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/DEVELOPMENT.md) for information on contributing to this project.
43
+
44
+ ## Additional Information
45
+ Additional information can be found at these locations.
46
+
47
+ | Title | Document | Description |
48
+ | --- | --- | --- |
49
+ | Code of Conduct | [CODE_OF_CONDUCT.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CODE_OF_CONDUCT.md) | Information about the norms, rules, and responsibilities we adhere to when participating in this open source community. |
50
+ | Contributing | [CONTRIBUTING.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/CONTRIBUTING.md) | Information about contributing to this project. |
51
+ | Development | [DEVELOPMENT.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. |
52
+ | Governance | [GOVERNANCE.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/GOVERNANCE.md) | Information about how this project is governed. |
53
+ | Maintainers | [MAINTAINERS.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/MAINTAINERS.md) | Information about individuals who maintain this project. |
54
+ | Security | [SECURITY.md](https://github.com/davidbrownell/dbrownell_ToolsDirectory/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
55
+
56
+ ## License
57
+ `dbrownell_ToolsDirectory` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
dbrownell_toolsdirectory-0.1.0/pyproject.toml ADDED
@@ -0,0 +1,89 @@
1
+ [project]
2
+ name = "dbrownell-toolsdirectory"
3
+ version = "0.1.0"
4
+ # ^^^^^
5
+ # Wheel names will be generated according to this value. Do not manually modify this value; instead
6
+ # update it according to committed changes by running this command from the root of the repository:
7
+ #
8
+ # uv run python -m AutoGitSemVer.scripts.UpdatePythonVersion ./pyproject.toml ./src
9
+
10
+ description = "Creates functionality to manipulate the shell in support of tools defined within a tools directory."
11
+ readme = "README.md"
12
+ authors = [
13
+ { name = "David Brownell", email = "github@DavidBrownell.com" }
14
+ ]
15
+ requires-python = ">= 3.14"
16
+ dependencies = []
17
+ classifiers = [
18
+ "Operating System :: MacOS",
19
+ "Operating System :: Microsoft :: Windows",
20
+ "Operating System :: POSIX :: Linux",
21
+ "Programming Language :: Python",
22
+ "Programming Language :: Python :: 3.14",
23
+ ]
24
+
25
+ [project.license]
26
+ text = "MIT"
27
+
28
+ [project.urls]
29
+ Homepage = "https://github.com/davidbrownell/dbrownell_ToolsDirectory"
30
+ Documentation = "https://github.com/davidbrownell/dbrownell_ToolsDirectory"
31
+ Repository = "https://github.com/davidbrownell/dbrownell_ToolsDirectory"
32
+
33
+ [build-system]
34
+ requires = ["uv_build>=0.9.18,<0.10.0"]
35
+ build-backend = "uv_build"
36
+
37
+ [dependency-groups]
38
+ dev = [
39
+ "autogitsemver>=0.9.2",
40
+ "pre-commit>=4.5.1",
41
+ "pytest>=9.0.2",
42
+ "pytest-cov>=7.0.0",
43
+ "ruff>=0.14.10",
44
+ ]
45
+
46
+ [tool.pytest.ini_options]
47
+ addopts = "--verbose -vv --capture=no --cov=dbrownell_ToolsDirectory --cov-report html --cov-report term --cov-report xml:coverage.xml --cov-fail-under=95.0"
48
+
49
+ [tool.ruff]
50
+ line-length = 110
51
+
52
+ [tool.ruff.lint]
53
+ exclude = ["tests/**"]
54
+
55
+ select = ["ALL"]
56
+
57
+ ignore = [
58
+ "ANN002", # Missing type annotation for `*args`
59
+ "ANN003", # Missing type annotation for `**kwargs`
60
+ "BLE001", # Do not catch blind exception: `Exception`
61
+ "COM812", # Trailing comma missing
62
+ "D105", # Missing docstring in magic method
63
+ "D107", # Missing docstring in `__init__` method
64
+ "D202", # No blank lines allowed after function docstring
65
+ "E501", # Line too long
66
+ "FIX002", # Line contains TODO, consider resolving the issue
67
+ "I001", # Import block is un-sorted or un-formatted
68
+ "N802", # Function name `xxx` should be lowercase
69
+ "N999", # Invalid module name
70
+ "RSE102", # Unnecessary parentheses on raise exception
71
+ "S101", # Use of assert detected
72
+ "TC006", # Add quotes to type expression in `typing.cast()`
73
+ "TD002", # Missing author in TODO
74
+ "TD003", # Missing issue link for this TODO
75
+ "TRY002", # Create your own exception
76
+ "TRY300", # Consider moving this statement to an `else` block
77
+ "UP032", # Use f-string instead of `format` call
78
+ ]
79
+
80
+ [tool.ruff.lint.mccabe]
81
+ max-complexity = 15
82
+
83
+ [tool.ruff.lint.pylint]
84
+ max-args = 10
85
+ max-branches = 20
86
+ max-returns = 20
87
+
88
+ [tool.uv.build-backend]
89
+ module-name = "dbrownell_ToolsDirectory"
dbrownell_toolsdirectory-0.1.0/src/dbrownell_ToolsDirectory/UvScaffolding_sample_file.py ADDED
@@ -0,0 +1,11 @@
1
+ """A sample file generated by copier - this file is safe to delete."""
2
+
3
+
4
+ def Add(a: int, b: int) -> int:
5
+ """Add two numbers."""
6
+ return a + b
7
+
8
+
9
+ def Subtract(a: int, b: int) -> int:
10
+ """Subtract two numbers."""
11
+ return a - b
dbrownell_toolsdirectory-0.1.0/src/dbrownell_ToolsDirectory/__init__.py ADDED
@@ -0,0 +1,6 @@
1
+ # noqa: D104
2
+
3
+ from importlib.metadata import version
4
+
5
+
6
+ __version__ = version("dbrownell_ToolsDirectory")