sciform 0.37.0__py3-none-any.whl → 0.38.0__py3-none-any.whl

{sciform-0.37.0.dist-info → sciform-0.38.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sciform
-Version: 0.37.0
+Version: 0.38.0
 Summary: A package for formatting numbers into scientific formatted strings.
 Author-email: Justin Gerber <justin.gerber48@gmail.com>
 Project-URL: homepage, https://github.com/jagerber48/sciform
@@ -21,42 +21,53 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: ruff ; extra == 'dev'
-Requires-Dist: coverage ; extra == 'dev'
-Requires-Dist: sphinx ; extra == 'dev'
-Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
-Requires-Dist: sphinx-toolbox ; extra == 'dev'
-Requires-Dist: numpy ; extra == 'dev'
+Provides-Extra: all
+Requires-Dist: sciform[docs] ; extra == 'all'
+Requires-Dist: sciform[test] ; extra == 'all'
+Requires-Dist: sciform[examples] ; extra == 'all'
+Provides-Extra: docs
+Requires-Dist: sphinx ; extra == 'docs'
+Requires-Dist: sphinx-rtd-dark-mode ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
+Requires-Dist: sphinx-toolbox ; extra == 'docs'
 Provides-Extra: examples
 Requires-Dist: numpy ; extra == 'examples'
 Requires-Dist: scipy ; extra == 'examples'
 Requires-Dist: matplotlib ; extra == 'examples'
 Requires-Dist: tabulate ; extra == 'examples'
 Requires-Dist: jupyter ; extra == 'examples'
+Provides-Extra: test
+Requires-Dist: coverage[toml] ; extra == 'test'
+Requires-Dist: numpy ; extra == 'test'
+Requires-Dist: ruff ==0.5.5 ; extra == 'test'
+Requires-Dist: sciform[docs] ; extra == 'test'
 
-.. image:: https://www.repostatus.org/badges/latest/wip.svg
+.. container::
+
+    |Repo Status| |pyOpenSci| |Documentation Status| |PyPI Version| |PyPI Python| |Coverage Status| |GH Workflow Status| |Zenodo|
+
+.. |Repo Status| image:: https://www.repostatus.org/badges/latest/wip.svg
      :target: https://www.repostatus.org/#wip
      :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
-.. image:: https://tinyurl.com/y22nb8up
+.. |pyOpenSci| image:: https://tinyurl.com/y22nb8up
      :target: https://github.com/pyOpenSci/software-review/issues/121
      :alt: pyOpenSci
-.. image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
+.. |Documentation Status| image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F
      :target: https://sciform.readthedocs.io/en/stable/
      :alt: Read the Docs
-.. image:: https://img.shields.io/pypi/v/sciform?logo=pypi
+.. |PyPI Version| image:: https://img.shields.io/pypi/v/sciform?logo=pypi
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Version
-.. image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
+.. |PyPI Python| image:: https://img.shields.io/pypi/pyversions/sciform?logo=python
      :target: https://pypi.org/project/sciform/
      :alt: PyPI - Python Version
-.. image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
+.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/jagerber48/sciform?logo=codecov
      :target: https://codecov.io/gh/jagerber48/sciform
      :alt: Codecov
-.. image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
+.. |GH Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/jagerber48/sciform/python-package.yml?logo=github%20actions
      :target: https://github.com/jagerber48/sciform/blob/main/.github/workflows/python-package.yml
      :alt: GitHub Workflow Status
-.. image:: https://zenodo.org/badge/645611310.svg
+.. |Zenodo| image:: https://zenodo.org/badge/645611310.svg
      :target: https://zenodo.org/doi/10.5281/zenodo.10645272
      :alt: Zenodo
 
@@ -65,9 +76,9 @@ Requires-Dist: jupyter ; extra == 'examples'
 sciform
 #######
 
-|  **Repository:** `<https://github.com/jagerber48/sciform>`_
-|  **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
-|  **PyPi:** `<https://pypi.org/project/sciform/>`_
+| **Repository:** `<https://github.com/jagerber48/sciform>`_
+| **Documentation:** `<https://sciform.readthedocs.io/en/stable/>`_
+| **PyPi:** `<https://pypi.org/project/sciform/>`_
 
 We would greatly appreciate you taking the time to fill out the
 `User Experience Survey <https://forms.gle/TkkKgywYyEMKu9U37>`_ to help
@@ -114,55 +125,55 @@ For many more details see
 
 ``sciform`` provides a wide variety of formatting options which can be
 controlled when constructing ``Formatter`` objects which are then used
-to format numbers into strings according to the selected options.
-
->>> from sciform import Formatter
->>> formatter = Formatter(
-...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
-... )
->>> print(formatter(51413.14159265359))
-51 413.141 593
->>> formatter = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.78))
-123.5e+03
+to format numbers into strings according to the selected options::
+
+  >>> from sciform import Formatter
+  >>> formatter = Formatter(
+  ...     round_mode="dec_place", ndigits=6, upper_separator=" ", lower_separator=" "
+  ... )
+  >>> print(formatter(51413.14159265359))
+  51 413.141 593
+  >>> formatter = Formatter(round_mode="sig_fig", ndigits=4, exp_mode="engineering")
+  >>> print(formatter(123456.78))
+  123.5e+03
 
 Users can also format numbers by constructing ``SciNum`` objects and
 using string formatting to format the ``SciNum`` instances according
-to a custom FSML.
+to a custom FSML::
 
->>> from sciform import SciNum
->>> num = SciNum(12345)
->>> print(f"{num:!2f}")
-12000
->>> print(f"{num:!2r}")
-12e+03
+  >>> from sciform import SciNum
+  >>> num = SciNum(12345)
+  >>> print(f"{num:!2f}")
+  12000
+  >>> print(f"{num:!2r}")
+  12e+03
 
 In addition to formatting individual numbers, ``sciform`` can be used
 to format pairs of numbers as value/uncertainty pairs.
 This can be done by passing two numbers into a ``Formatter`` call or by
-using the ``SciNum`` object.
+using the ``SciNum`` object::
 
->>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
->>> print(formatter(123456.654321, 0.00345))
-123 456.654 3 ± 0.003 4
->>> formatter = Formatter(ndigits=4, exp_mode="engineering")
->>> print(formatter(123456.654321, 0.00345))
-(123.456654321 ± 0.000003450)e+03
+  >>> formatter = Formatter(ndigits=2, upper_separator=" ", lower_separator=" ")
+  >>> print(formatter(123456.654321, 0.00345))
+  123 456.654 3 ± 0.003 4
+  >>> formatter = Formatter(ndigits=4, exp_mode="engineering")
+  >>> print(formatter(123456.654321, 0.00345))
+  (123.456654321 ± 0.000003450)e+03
 
->>> num = SciNum(123456.654321, 0.00345)
->>> print(f"{num:!2f}")
-123456.6543 ± 0.0034
->>> print(f"{num:!2f()}")
-123456.6543(34)
+  >>> num = SciNum(123456.654321, 0.00345)
+  >>> print(f"{num:!2f}")
+  123456.6543 ± 0.0034
+  >>> print(f"{num:!2f()}")
+  123456.6543(34)
 
 Note that the above examples demonstrate that ``sciform`` uses
 `"round-to-even" <https://en.wikipedia.org/wiki/Rounding#Rounding_half_to_even>`_
-rounding.
+rounding::
 
->>> print(f"{SciNum(865):!2}")
-860
->>> print(f"{SciNum(875):!2}")
-880
+  >>> print(f"{SciNum(865):!2}")
+  860
+  >>> print(f"{SciNum(875):!2}")
+  880
 
 See `Formatting Options <https://sciform.readthedocs.io/en/stable/options.html>`_,
 `Format Specification Mini-Language <https://sciform.readthedocs.io/en/stable/fsml.html>`_

sciform-0.38.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+sciform/__init__.py,sha256=Lnb1fep9vjJ7n4U5YdNqRkq9saXuRvppedpW1TZm99Y,781
+sciform/api/__init__.py,sha256=kWXKOuVgwn3580EBGGs4t2uK7_uBgjfvQq2r8b9ZPrM,24
+sciform/api/formatted_number.py,sha256=VdQGRXmUy_Pwc2SeYT8KlZMJBJDu0maI0HHv9DXu1fQ,2804
+sciform/api/formatter.py,sha256=0eOLQmrNnhDO05rbMMOhPjYUYYkW5fT-SiUAxGKXWEI,15554
+sciform/api/global_configuration.py,sha256=iSmGcnfs-2cvWz27t9ka9ibDuN732sLwDsLJTi8SA-g,6866
+sciform/api/scinum.py,sha256=XF4QiBAlehEKnk_NwDDVWmLnRDwfEalmuzC8b2qUE4Q,3363
+sciform/format_utils/__init__.py,sha256=9tCbjsOOiqvw0DoMUo9qcIC8pFykfVZZ8wkEIRAh-OE,132
+sciform/format_utils/exp_translations.py,sha256=uh9ZxDKcGcMVSNwj7qkr5TSA6MINIaU1RHZeqKVwEQ0,575
+sciform/format_utils/exponents.py,sha256=khG9mkHRG-qb2Xnd_lpkLXwV8KcHUJekgC8MwgfSL_U,3976
+sciform/format_utils/grouping.py,sha256=1hZjjVKRUy477LGGFniZwwEHHBDaSb6E0K3SAeCACVY,1641
+sciform/format_utils/make_strings.py,sha256=4g1E3UBDLeoF272OpIGCiuzeZ4KsDjWNiXvbMIfr3sg,5258
+sciform/format_utils/numbers.py,sha256=L3J8B7GR6RWNaYthDmnY5d4bLYBviCYw-Evqb754VTw,5799
+sciform/format_utils/rounding.py,sha256=VkvIg_UNpGfBG8QQQVGLZPwNfw5Tj3jlM8Wgx1r6ils,3491
+sciform/formatting/__init__.py,sha256=T_DnF4vkeAQx1xuzff7rRZbWj-hEbNI6Pj2D2831L9E,38
+sciform/formatting/fsml.py,sha256=J2Zd7RD4E32hNTP2Vo_2PEvzHBt3aIUerhLT72stovQ,3843
+sciform/formatting/number_formatting.py,sha256=_4SxAzo3VLp6_ThrJfn9yQu3rH_0_27NOftNSPfIMA8,12268
+sciform/formatting/output_conversion.py,sha256=TdcfQa0p7S7iIkqcwVYbxCGwoGu4mPOV3XzjABnaGmA,5523
+sciform/formatting/parser.py,sha256=58noOOyg5m3NKJwGfEEwiUivzm5vGPG3K1_OXIrrVAk,16310
+sciform/options/__init__.py,sha256=tw_CZHaNrdixZoQyG6ZD5UMKkQxXok0qBQCxt28Gh20,51
+sciform/options/conversion.py,sha256=2ad0Mwwb7qqJ5xClevxaUVkVznokQBmAVVewh_5-7jU,4146
+sciform/options/finalized_options.py,sha256=r38T1qp2sLD0mVIOovfax2Q46zb7yjjypr1CpUsqMCA,1262
+sciform/options/global_options.py,sha256=T_OXFKi2qO5PV-LTZt9ClppWYsUmStBgyQqFuoX6idM,697
+sciform/options/input_options.py,sha256=ibUMS9q_hdf9lms90hA6FzbEZpe-KVdZg5K-A1H7j3Q,3806
+sciform/options/option_types.py,sha256=nZa_HZHlRf6ILbKxXbP1lqB3s9WoJRYv0uLQonY5ud8,2346
+sciform/options/populated_options.py,sha256=7TBuSxBvcUopF16NIMQuGoAT6B0vq0HLigO7qrIld1A,4961
+sciform/options/validation.py,sha256=b70AE6AqbNjEsBkVXwYDQRCQnwVbqWWJ7eUxh2jkyqU,8092
+sciform-0.38.0.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
+sciform-0.38.0.dist-info/METADATA,sha256=nkbgc_oPKFgkBrPK3wRVXuXIWJvMnXSbp7ugU-PTUGk,8990
+sciform-0.38.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+sciform-0.38.0.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
+sciform-0.38.0.dist-info/RECORD,,

{sciform-0.37.0.dist-info → sciform-0.38.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sciform-0.37.0.dist-info/RECORD

@@ -1,31 +0,0 @@
-sciform/__init__.py,sha256=gE7q7AYCOqjjy98_H1mIW3CSqPBbkP-SI8clpVFVKZw,881
-sciform/api/__init__.py,sha256=kWXKOuVgwn3580EBGGs4t2uK7_uBgjfvQq2r8b9ZPrM,24
-sciform/api/formatted_number.py,sha256=VdQGRXmUy_Pwc2SeYT8KlZMJBJDu0maI0HHv9DXu1fQ,2804
-sciform/api/formatter.py,sha256=t0AduoIny7HlCBzjlBwFPXzN00tiaMvZCTs8tWqHfnA,16083
-sciform/api/global_configuration.py,sha256=jqX-bWTtYjghtfyx3B7S5OIi88PMZC4YMmRBtaNxGVE,7052
-sciform/api/scinum.py,sha256=XF4QiBAlehEKnk_NwDDVWmLnRDwfEalmuzC8b2qUE4Q,3363
-sciform/format_utils/__init__.py,sha256=9tCbjsOOiqvw0DoMUo9qcIC8pFykfVZZ8wkEIRAh-OE,132
-sciform/format_utils/exp_translations.py,sha256=uh9ZxDKcGcMVSNwj7qkr5TSA6MINIaU1RHZeqKVwEQ0,575
-sciform/format_utils/exponents.py,sha256=fXRoZ1pqY2kuW9UliTDs0fdcKMJTtWFnHpqe2e2AidE,4017
-sciform/format_utils/grouping.py,sha256=1hZjjVKRUy477LGGFniZwwEHHBDaSb6E0K3SAeCACVY,1641
-sciform/format_utils/make_strings.py,sha256=REyFe7taSq6ay5IgM2iPvfB5A9SAFT7Ie4Uo6_6I5PU,4802
-sciform/format_utils/numbers.py,sha256=DTkHxAhTrwKqOdbjt5qjTVJwdyJP4lTar-olmyLWbq4,5845
-sciform/format_utils/rounding.py,sha256=Ie09AIpQmiCaSi4cH98VyR34u3gsBxM1X5AWqZ3CgbE,3655
-sciform/formatting/__init__.py,sha256=T_DnF4vkeAQx1xuzff7rRZbWj-hEbNI6Pj2D2831L9E,38
-sciform/formatting/fsml.py,sha256=r22RiBPrkDaiPgE2VQrtGms9aBmWqolymsmmnp-z57s,3378
-sciform/formatting/number_formatting.py,sha256=mvT15rwSFtogaM_JFqXzFQMA9zdT5vmW8QWfYMrJ-AM,10947
-sciform/formatting/output_conversion.py,sha256=TdcfQa0p7S7iIkqcwVYbxCGwoGu4mPOV3XzjABnaGmA,5523
-sciform/formatting/parser.py,sha256=58noOOyg5m3NKJwGfEEwiUivzm5vGPG3K1_OXIrrVAk,16310
-sciform/options/__init__.py,sha256=tw_CZHaNrdixZoQyG6ZD5UMKkQxXok0qBQCxt28Gh20,51
-sciform/options/conversion.py,sha256=HdFUoUmYFhcMjhB5i-LikE20seDJkb9sq3RblERxkck,4079
-sciform/options/finalized_options.py,sha256=CdNTcASBYnYIr9wDZ_NLN8HiU3fdbtoL2CQbfJhV7go,1487
-sciform/options/global_options.py,sha256=bSOd3J7-U-R-t-JqZdQI2Jo2F6O9xNijmCkTpcrOybY,805
-sciform/options/input_options.py,sha256=c3mihX5BjmFNeqH4N1rJ9emtOFQf43Enj2YLmy8RP4Y,3885
-sciform/options/option_types.py,sha256=8slohyIPHeAdgq3aszoNq9RJl6ibageFqDMxeC9NhrQ,3893
-sciform/options/populated_options.py,sha256=eo2MNTXUElTMnhgp1CcEp9ym5G9E6v9GxSZwHt3AnKI,5085
-sciform/options/validation.py,sha256=ghkfGBp29AMdGsgYU90YFtfuj8KxCiYDJngsAMuJ0ys,8064
-sciform-0.37.0.dist-info/LICENSE,sha256=-oyCEZu-6HLrRSfRg44uuNDE0c59GVEdqYIgidqSP70,1056
-sciform-0.37.0.dist-info/METADATA,sha256=vNibMXv4XqUkcaZXw7XbXNd8iYkNpQUUVsvFEqaIzB0,8351
-sciform-0.37.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sciform-0.37.0.dist-info/top_level.txt,sha256=mC01YOQ-1u5pDk9BJia-pQKLUMvkreMsldDpFcp7NV8,8
-sciform-0.37.0.dist-info/RECORD,,