stringcalc 0.1.0__tar.gz → 0.1.0a1__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 (34) hide show
  1. stringcalc-0.1.0a1/PKG-INFO +57 -0
  2. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/README.md +1 -1
  3. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/cli.rst +0 -8
  4. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/index.md +55 -55
  5. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/pyproject.toml +2 -5
  6. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/__init__.py +1 -1
  7. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/_version.py +2 -2
  8. stringcalc-0.1.0/PKG-INFO +0 -37
  9. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/.gitignore +0 -0
  10. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/LICENSE +0 -0
  11. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/api.rst +0 -0
  12. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/cli_gauge-suggest_tb23nw.svg +0 -0
  13. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/cli_gauge-suggest_tb23nw_d.svg +0 -0
  14. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/conf.py +0 -0
  15. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/dev.md +0 -0
  16. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/examples/compare-data.md +0 -0
  17. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/examples/gauge-suggest.md +0 -0
  18. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/examples/pythagoras-ratios.md +0 -0
  19. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/examples/tension-plot.md +0 -0
  20. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/panel.rst +0 -0
  21. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/docs/prior-art.md +0 -0
  22. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/cli.py +0 -0
  23. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/__init__.py +0 -0
  24. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/aquila-nng.csv +0 -0
  25. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/daddario-stp.csv +0 -0
  26. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/daddario-tension.csv +0 -0
  27. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/ghs.csv +0 -0
  28. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/stringjoy.csv +0 -0
  29. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/data/worth.csv +0 -0
  30. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/frets.py +0 -0
  31. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/py.typed +0 -0
  32. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/stringcalc/tension.py +0 -0
  33. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/tests/test_frets.py +0 -0
  34. {stringcalc-0.1.0 → stringcalc-0.1.0a1}/tests/test_string.py +0 -0
@@ -0,0 +1,57 @@
1
+ Metadata-Version: 2.4
2
+ Name: stringcalc
3
+ Version: 0.1.0a1
4
+ Dynamic: Summary
5
+ Project-URL: Home, https://github.com/zmoon/stringcalc
6
+ Project-URL: Source, https://github.com/zmoon/stringcalc
7
+ Project-URL: Documentation, https://stringcalc.readthedocs.io
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.
30
+ License-File: LICENSE
31
+ Classifier: License :: OSI Approved :: MIT License
32
+ Requires-Python: <4,>=3.10
33
+ Requires-Dist: numpy>=1.21
34
+ Requires-Dist: pandas
35
+ Requires-Dist: pint>=0.22
36
+ Requires-Dist: pyabc2
37
+ Provides-Extra: cli
38
+ Requires-Dist: rich; extra == 'cli'
39
+ Requires-Dist: typer; extra == 'cli'
40
+ Description-Content-Type: text/markdown
41
+
42
+ # stringcalc
43
+
44
+ _Calculations for [string instrument](https://en.wikipedia.org/wiki/String_instrument)s' strings_
45
+
46
+ [![Version on PyPI](https://img.shields.io/pypi/v/stringcalc.svg)](https://pypi.org/project/stringcalc/)
47
+ [![CI workflow status](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml/badge.svg)](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml)
48
+ [![Documentation status](https://readthedocs.org/projects/stringcalc/badge/?version=latest)](https://stringcalc.readthedocs.io/en/latest/)
49
+ [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
50
+
51
+ ```sh
52
+ stringcalc gauge --suggest -T 17 -L 23 -P G2 -P D3 -P A3 -P E4 -N 6 --type DA:LEW --type DA:LE --no-column-info
53
+ ```
54
+
55
+ <img src="https://raw.githubusercontent.com/zmoon/stringcalc/refs/heads/main/docs/cli_gauge-suggest_tb23nw.svg"
56
+ alt="CLI gauge suggestion output for 23&quot; TB for D'Addario loop-end nickel-wound strings"
57
+ width="550">
@@ -5,7 +5,7 @@ _Calculations for [string instrument](https://en.wikipedia.org/wiki/String_instr
5
5
  [![Version on PyPI](https://img.shields.io/pypi/v/stringcalc.svg)](https://pypi.org/project/stringcalc/)
6
6
  [![CI workflow status](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml/badge.svg)](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml)
7
7
  [![Documentation status](https://readthedocs.org/projects/stringcalc/badge/?version=latest)](https://stringcalc.readthedocs.io/en/latest/)
8
- [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
8
+ [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
9
9
 
10
10
  ```sh
11
11
  stringcalc gauge --suggest -T 17 -L 23 -P G2 -P D3 -P A3 -P E4 -N 6 --type DA:LEW --type DA:LE --no-column-info
@@ -6,14 +6,6 @@ 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
-
17
9
  .. click:: stringcalc.cli:_typer_click_object
18
10
  :prog: stringcalc
19
11
  :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,13 +1,12 @@
1
1
  [build-system]
2
- requires = ["hatchling", "hatch-vcs", "hatch-docstring-description"]
2
+ requires = ["hatchling", "hatch-vcs"]
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 = "MIT"
10
- license-files = ["LICENSE"]
9
+ license = {file = "LICENSE"}
11
10
  classifiers = ["License :: OSI Approved :: MIT License"]
12
11
  dynamic = ["version", "description"]
13
12
  requires-python = ">=3.10,<4"
@@ -66,8 +65,6 @@ source = "vcs"
66
65
  [tool.hatch.build.hooks.vcs]
67
66
  version-file = "stringcalc/_version.py"
68
67
 
69
- [tool.hatch.metadata.hooks.docstring-description]
70
-
71
68
  [tool.hatch.build.targets.sdist]
72
69
  exclude = [
73
70
  ".flake8",
@@ -1,5 +1,5 @@
1
1
  """
2
- Instrument string calculations
2
+ Calculations for instrument strings
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.0'
32
- __version_tuple__ = version_tuple = (0, 1, 0)
31
+ __version__ = version = '0.1.0a1'
32
+ __version_tuple__ = version_tuple = (0, 1, 0, 'a1')
33
33
 
34
34
  __commit_id__ = commit_id = None
stringcalc-0.1.0/PKG-INFO DELETED
@@ -1,37 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: stringcalc
3
- Version: 0.1.0
4
- Summary: Instrument string calculations
5
- Project-URL: Home, https://github.com/zmoon/stringcalc
6
- Project-URL: Source, https://github.com/zmoon/stringcalc
7
- Project-URL: Documentation, https://stringcalc.readthedocs.io
8
- Author-email: zmoon <zmoon92@gmail.com>
9
- License-Expression: MIT
10
- License-File: LICENSE
11
- Classifier: License :: OSI Approved :: MIT License
12
- Requires-Python: <4,>=3.10
13
- Requires-Dist: numpy>=1.21
14
- Requires-Dist: pandas
15
- Requires-Dist: pint>=0.22
16
- Requires-Dist: pyabc2
17
- Provides-Extra: cli
18
- Requires-Dist: rich; extra == 'cli'
19
- Requires-Dist: typer; extra == 'cli'
20
- Description-Content-Type: text/markdown
21
-
22
- # stringcalc
23
-
24
- _Calculations for [string instrument](https://en.wikipedia.org/wiki/String_instrument)s' strings_
25
-
26
- [![Version on PyPI](https://img.shields.io/pypi/v/stringcalc.svg)](https://pypi.org/project/stringcalc/)
27
- [![CI workflow status](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml/badge.svg)](https://github.com/zmoon/stringcalc/actions/workflows/ci.yml)
28
- [![Documentation status](https://readthedocs.org/projects/stringcalc/badge/?version=latest)](https://stringcalc.readthedocs.io/en/latest/)
29
- [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
30
-
31
- ```sh
32
- stringcalc gauge --suggest -T 17 -L 23 -P G2 -P D3 -P A3 -P E4 -N 6 --type DA:LEW --type DA:LE --no-column-info
33
- ```
34
-
35
- <img src="https://raw.githubusercontent.com/zmoon/stringcalc/refs/heads/main/docs/cli_gauge-suggest_tb23nw.svg"
36
- alt="CLI gauge suggestion output for 23&quot; TB for D'Addario loop-end nickel-wound strings"
37
- width="550">
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes