reference-package 0.6.4__tar.gz → 0.7.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 (21) hide show
  1. {reference_package-0.6.4/src/reference_package.egg-info → reference_package-0.7.0}/PKG-INFO +13 -3
  2. {reference_package-0.6.4 → reference_package-0.7.0}/README.md +10 -0
  3. reference_package-0.7.0/pyproject.toml +9 -0
  4. {reference_package-0.6.4 → reference_package-0.7.0}/setup.cfg +3 -3
  5. {reference_package-0.6.4 → reference_package-0.7.0/src/reference_package.egg-info}/PKG-INFO +13 -3
  6. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package.egg-info/requires.txt +2 -4
  7. reference_package-0.6.4/pyproject.toml +0 -3
  8. {reference_package-0.6.4 → reference_package-0.7.0}/LICENSE +0 -0
  9. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/__init__.py +0 -0
  10. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/api/__init__.py +0 -0
  11. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/api/internal.py +0 -0
  12. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/api/public.py +0 -0
  13. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/cli/__init__.py +0 -0
  14. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/cli/example.py +0 -0
  15. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/lib/__init__.py +0 -0
  16. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/lib/constants.py +0 -0
  17. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package/lib/example.py +0 -0
  18. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package.egg-info/SOURCES.txt +0 -0
  19. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package.egg-info/dependency_links.txt +0 -0
  20. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package.egg-info/entry_points.txt +0 -0
  21. {reference_package-0.6.4 → reference_package-0.7.0}/src/reference_package.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: reference_package
3
- Version: 0.6.4
3
+ Version: 0.7.0
4
4
  Summary: A basic package setup with examples.
5
5
  Author: Kaleb Coberly
6
6
  Maintainer-email: kaleb.coberly@gmail.com
@@ -45,8 +45,8 @@ Requires-Dist: flake8-bugbear; extra == "qc"
45
45
  Requires-Dist: flake8-docstrings; extra == "qc"
46
46
  Requires-Dist: flake8-isort; extra == "qc"
47
47
  Requires-Dist: isort; extra == "qc"
48
- Requires-Dist: jake; extra == "qc"
49
- Requires-Dist: pytype; python_version < "3.13" and extra == "qc"
48
+ Requires-Dist: mypy; extra == "qc"
49
+ Requires-Dist: pip-audit; extra == "qc"
50
50
  Requires-Dist: reference_package[test]; extra == "qc"
51
51
  Requires-Dist: safety; extra == "qc"
52
52
  Provides-Extra: test
@@ -215,6 +215,16 @@ When making smaller commits, you might just want to run some of the smaller comm
215
215
  $ make clean format full-qc full-test
216
216
  ```
217
217
 
218
+ #### Type Checking
219
+
220
+ This project uses [mypy](https://mypy-lang.org) for type checking.
221
+
222
+ To run type checking:
223
+
224
+ ```bash
225
+ $ make typecheck
226
+ ```
227
+
218
228
  ### Workflows: usage and limitations
219
229
 
220
230
  QC, tests, builds, and deployment run on GitHub on certain events (e.g., pull requests, pushes to main, manual dispatches) using the workflows found in `.github/workflows`.
@@ -158,6 +158,16 @@ When making smaller commits, you might just want to run some of the smaller comm
158
158
  $ make clean format full-qc full-test
159
159
  ```
160
160
 
161
+ #### Type Checking
162
+
163
+ This project uses [mypy](https://mypy-lang.org) for type checking.
164
+
165
+ To run type checking:
166
+
167
+ ```bash
168
+ $ make typecheck
169
+ ```
170
+
161
171
  ### Workflows: usage and limitations
162
172
 
163
173
  QC, tests, builds, and deployment run on GitHub on certain events (e.g., pull requests, pushes to main, manual dispatches) using the workflows found in `.github/workflows`.
@@ -0,0 +1,9 @@
1
+ [build-system]
2
+ requires = ["setuptools"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [tool.mypy]
6
+ [[tool.mypy.overrides]]
7
+ # TODO: Remove once we've added stubs for comb_utils.
8
+ module = "comb_utils.*"
9
+ ignore_missing_imports = true
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = reference_package
3
- version = 0.6.4
3
+ version = 0.7.0
4
4
  description = A basic package setup with examples.
5
5
  long_description = file: README.md
6
6
  long_description_content_type = text/markdown
@@ -62,8 +62,8 @@ qc =
62
62
  flake8-docstrings
63
63
  flake8-isort
64
64
  isort
65
- jake
66
- pytype; python_version < "3.13"
65
+ mypy
66
+ pip-audit
67
67
  reference_package[test]
68
68
  safety
69
69
  test =
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: reference_package
3
- Version: 0.6.4
3
+ Version: 0.7.0
4
4
  Summary: A basic package setup with examples.
5
5
  Author: Kaleb Coberly
6
6
  Maintainer-email: kaleb.coberly@gmail.com
@@ -45,8 +45,8 @@ Requires-Dist: flake8-bugbear; extra == "qc"
45
45
  Requires-Dist: flake8-docstrings; extra == "qc"
46
46
  Requires-Dist: flake8-isort; extra == "qc"
47
47
  Requires-Dist: isort; extra == "qc"
48
- Requires-Dist: jake; extra == "qc"
49
- Requires-Dist: pytype; python_version < "3.13" and extra == "qc"
48
+ Requires-Dist: mypy; extra == "qc"
49
+ Requires-Dist: pip-audit; extra == "qc"
50
50
  Requires-Dist: reference_package[test]; extra == "qc"
51
51
  Requires-Dist: safety; extra == "qc"
52
52
  Provides-Extra: test
@@ -215,6 +215,16 @@ When making smaller commits, you might just want to run some of the smaller comm
215
215
  $ make clean format full-qc full-test
216
216
  ```
217
217
 
218
+ #### Type Checking
219
+
220
+ This project uses [mypy](https://mypy-lang.org) for type checking.
221
+
222
+ To run type checking:
223
+
224
+ ```bash
225
+ $ make typecheck
226
+ ```
227
+
218
228
  ### Workflows: usage and limitations
219
229
 
220
230
  QC, tests, builds, and deployment run on GitHub on certain events (e.g., pull requests, pushes to main, manual dispatches) using the workflows found in `.github/workflows`.
@@ -40,13 +40,11 @@ flake8-bugbear
40
40
  flake8-docstrings
41
41
  flake8-isort
42
42
  isort
43
- jake
43
+ mypy
44
+ pip-audit
44
45
  reference_package[test]
45
46
  safety
46
47
 
47
- [qc:python_version < "3.13"]
48
- pytype
49
-
50
48
  [test]
51
49
  coverage[toml]
52
50
  pytest
@@ -1,3 +0,0 @@
1
- [build-system]
2
- requires = ["setuptools"]
3
- build-backend = "setuptools.build_meta"