stringcalc 0.1.0a1__tar.gz → 0.1.0a3__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 (33) hide show
  1. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/PKG-INFO +3 -23
  2. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/cli.rst +8 -0
  3. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/index.md +55 -55
  4. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/pyproject.toml +5 -2
  5. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/__init__.py +1 -1
  6. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/_version.py +2 -2
  7. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/.gitignore +0 -0
  8. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/LICENSE +0 -0
  9. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/README.md +0 -0
  10. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/api.rst +0 -0
  11. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/cli_gauge-suggest_tb23nw.svg +0 -0
  12. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/cli_gauge-suggest_tb23nw_d.svg +0 -0
  13. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/conf.py +0 -0
  14. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/dev.md +0 -0
  15. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/examples/compare-data.md +0 -0
  16. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/examples/gauge-suggest.md +0 -0
  17. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/examples/pythagoras-ratios.md +0 -0
  18. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/examples/tension-plot.md +0 -0
  19. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/panel.rst +0 -0
  20. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/docs/prior-art.md +0 -0
  21. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/cli.py +0 -0
  22. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/__init__.py +0 -0
  23. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/aquila-nng.csv +0 -0
  24. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/daddario-stp.csv +0 -0
  25. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/daddario-tension.csv +0 -0
  26. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/ghs.csv +0 -0
  27. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/stringjoy.csv +0 -0
  28. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/data/worth.csv +0 -0
  29. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/frets.py +0 -0
  30. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/py.typed +0 -0
  31. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/stringcalc/tension.py +0 -0
  32. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/tests/test_frets.py +0 -0
  33. {stringcalc-0.1.0a1 → stringcalc-0.1.0a3}/tests/test_string.py +0 -0
@@ -1,32 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: stringcalc
3
- Version: 0.1.0a1
4
- Dynamic: Summary
3
+ Version: 0.1.0a3
4
+ Summary: Instrument string calculations
5
5
  Project-URL: Home, https://github.com/zmoon/stringcalc
6
6
  Project-URL: Source, https://github.com/zmoon/stringcalc
7
7
  Project-URL: Documentation, https://stringcalc.readthedocs.io
8
8
  Author-email: zmoon <zmoon92@gmail.com>
9
- License: MIT License
10
-
11
- Copyright (c) 2022 Zachary Moon
12
-
13
- Permission is hereby granted, free of charge, to any person obtaining a copy
14
- of this software and associated documentation files (the "Software"), to deal
15
- in the Software without restriction, including without limitation the rights
16
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
- copies of the Software, and to permit persons to whom the Software is
18
- furnished to do so, subject to the following conditions:
19
-
20
- The above copyright notice and this permission notice shall be included in all
21
- copies or substantial portions of the Software.
22
-
23
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
- SOFTWARE.
9
+ License-Expression: MIT
30
10
  License-File: LICENSE
31
11
  Classifier: License :: OSI Approved :: MIT License
32
12
  Requires-Python: <4,>=3.10
@@ -6,6 +6,14 @@ For example, ``stringcalc gauge --suggest`` can be used to suggest strings.
6
6
  ``-T``, ``-L``, ``-P`` (tension, scale length, pitch)
7
7
  can be specified more than once to get results for multiple strings.
8
8
 
9
+ With `uv <https://docs.astral.sh/uv/>`__, you can install ``stringcalc`` globally with::
10
+
11
+ uv tool install stringcalc[cli]
12
+
13
+ or run it in an ephemeral environment with::
14
+
15
+ uvx stringcalc[cli]
16
+
9
17
  .. click:: stringcalc.cli:_typer_click_object
10
18
  :prog: stringcalc
11
19
  :nested: full
@@ -1,55 +1,55 @@
1
- # stringcalc
2
-
3
- Calculations for instrument strings.
4
-
5
- - {doc}`Python library <api>`
6
- - {doc}`Command-line interface <cli>`
7
- - {doc}`panel`
8
- - ...
9
-
10
- ## Installation
11
-
12
- stringcalc is available [on PyPI](https://pypi.org/project/stringcalc/):
13
-
14
- ```
15
- pip install stringcalc
16
- ```
17
-
18
- For the CLI, include the `cli` extra:
19
-
20
- ```
21
- pip install stringcalc[cli]
22
- ```
23
-
24
- ## Examples
25
-
26
- ```{nb-exec-table}
27
-
28
- ```
29
-
30
- ```{toctree}
31
- :hidden:
32
-
33
- panel.rst
34
- ```
35
-
36
- ```{toctree}
37
- :caption: Examples
38
- :hidden:
39
-
40
- examples/compare-data.md
41
- examples/gauge-suggest.md
42
- examples/tension-plot.md
43
- examples/pythagoras-ratios.md
44
- ```
45
-
46
- ```{toctree}
47
- :caption: Reference
48
- :hidden:
49
-
50
- api.rst
51
- cli.rst
52
- prior-art.md
53
- GitHub <https://github.com/zmoon/stringcalc>
54
- dev.md
55
- ```
1
+ # stringcalc
2
+
3
+ Calculations for instrument strings.
4
+
5
+ - {doc}`Python library <api>`
6
+ - {doc}`Command-line interface <cli>`
7
+ - {doc}`panel`
8
+ - ...
9
+
10
+ ## Installation
11
+
12
+ stringcalc is available [on PyPI](https://pypi.org/project/stringcalc/):
13
+
14
+ ```
15
+ pip install stringcalc
16
+ ```
17
+
18
+ For the CLI, include the `cli` extra:
19
+
20
+ ```
21
+ pip install stringcalc[cli]
22
+ ```
23
+
24
+ ## Examples
25
+
26
+ ```{nb-exec-table}
27
+
28
+ ```
29
+
30
+ ```{toctree}
31
+ :hidden:
32
+
33
+ panel.rst
34
+ ```
35
+
36
+ ```{toctree}
37
+ :caption: Examples
38
+ :hidden:
39
+
40
+ examples/compare-data.md
41
+ examples/gauge-suggest.md
42
+ examples/tension-plot.md
43
+ examples/pythagoras-ratios.md
44
+ ```
45
+
46
+ ```{toctree}
47
+ :caption: Reference
48
+ :hidden:
49
+
50
+ api.rst
51
+ cli.rst
52
+ prior-art.md
53
+ GitHub <https://github.com/zmoon/stringcalc>
54
+ dev.md
55
+ ```
@@ -1,12 +1,13 @@
1
1
  [build-system]
2
- requires = ["hatchling", "hatch-vcs"]
2
+ requires = ["hatchling", "hatch-vcs", "hatch-docstring-description"]
3
3
  build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "stringcalc"
7
7
  authors = [{name = "zmoon", email = "zmoon92@gmail.com"}]
8
8
  readme = "README.md"
9
- license = {file = "LICENSE"}
9
+ license = "MIT"
10
+ license-files = ["LICENSE"]
10
11
  classifiers = ["License :: OSI Approved :: MIT License"]
11
12
  dynamic = ["version", "description"]
12
13
  requires-python = ">=3.10,<4"
@@ -65,6 +66,8 @@ source = "vcs"
65
66
  [tool.hatch.build.hooks.vcs]
66
67
  version-file = "stringcalc/_version.py"
67
68
 
69
+ [tool.hatch.metadata.hooks.docstring-description]
70
+
68
71
  [tool.hatch.build.targets.sdist]
69
72
  exclude = [
70
73
  ".flake8",
@@ -1,5 +1,5 @@
1
1
  """
2
- Calculations for instrument strings
2
+ Instrument string calculations
3
3
  """
4
4
 
5
5
  try:
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
28
28
  commit_id: COMMIT_ID
29
29
  __commit_id__: COMMIT_ID
30
30
 
31
- __version__ = version = '0.1.0a1'
32
- __version_tuple__ = version_tuple = (0, 1, 0, 'a1')
31
+ __version__ = version = '0.1.0a3'
32
+ __version_tuple__ = version_tuple = (0, 1, 0, 'a3')
33
33
 
34
34
  __commit_id__ = commit_id = None
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes