Metadata-Version: 2.4
Name: sigfig
Version: 1.3.19
Summary: Python library for rounding numbers (with expected results)
Author-email: Michael Busuttil <mike.busuttil@gmail.com>, Travis Valdez <valdezt@gmail.com>
Maintainer-email: Michael Busuttil <mike.busuttil@gmail.com>
License: MIT License
Project-URL: Homepage, https://sigfig.readthedocs.io/
Project-URL: Documentation, https://sigfig.readthedocs.io/
Project-URL: Repository, https://github.com/drakegroup/sigfig.git
Project-URL: Issues, https://github.com/drakegroup/sigfig/issues
Keywords: round,rounding,significant figures,significant digits,sigfigs,sigdigs,decimals,uncertainty,uncertainties,numeric,numerical,number,numbers,data,format,style,publication
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Education
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: <4.0,>=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: sortedcontainers<3.0.0,>=2.4.0
Dynamic: license-file

﻿sigfig
=======

.. image:: https://img.shields.io/pypi/v/sigfig.svg
    :target: https://pypi.org/project/sigfig/
    :alt: Version
.. image:: https://readthedocs.org/projects/sigfig/badge/?version=latest
    :target: http://sigfig.readthedocs.io/
    :alt: Documentation
.. image:: https://img.shields.io/pypi/pyversions/sigfig.svg
    :target: https://pypi.python.org/pypi/sigfig/
    :alt: Python Versions
.. image:: https://raw.githubusercontent.com/drakegroup/sigfig/refs/heads/master/test/coverage.svg
    :target: https://github.com/drakegroup/sigfig/actions/workflows/smoke_test.yaml
    :alt: Coverage Status
.. image:: https://img.shields.io/pypi/dd/sigfig
    :target: https://pypistats.org/packages/sigfig
    :alt: Download Stats

This is the **sigfig** Python package used for rounding numbers (with expected results).

.. code:: python

    >>> round(0.25, 1)
    0.2
    >>> from sigfig import round
    >>> round(0.25, decimals=1)
    0.3
    >>> round(3.14159, sigfigs=2)
    3.1
    >>> round(3.14159, uncertainty=0.003639)
    '3.142 ± 0.004'
    >>> round('3.141592653589793', '0.00000002567', format='Drake')
    '3.141 592 654(26)'

Key Features:

* round numbers by significant figures/digits
* round numbers by decimal places
* round numbers by uncertainty/error
* format numbers in a variety of common styles & notations
* read in numbers of any type

In-depth documentation can be found here:

* `Installation <https://sigfig.readthedocs.io/en/latest/install.html>`_
* `Usage Guide <https://sigfig.readthedocs.io/en/latest/usage.html>`_
* `API Documentation <https://sigfig.readthedocs.io/en/latest/api.html>`_
* `Project Development & Roadmap <https://sigfig.readthedocs.io/en/latest/roadmap.html>`_

Useful links:

.. |pypi| image:: https://raw.githubusercontent.com/drakegroup/sigfig/refs/heads/master/doc/pypi-logo.svg
    :target: https://pypi.org/project/sigfig
    :height: 1em
.. |github| image:: https://raw.githubusercontent.com/FortAwesome/Font-Awesome/refs/heads/master/svgs/brands/github.svg
    :target: https://github.com/drakegroup/sigfig
    :height: 1em

*  |pypi| `Python Package Index entry <https://pypi.org/project/sigfig>`_ 
*  |github| `Source Code <https://github.com/drakegroup/sigfig>`_

Please direct any comments/suggestions/feedback/bugs to `the issues page <https://github.com/drakegroup/sigfig/issues>`_ or `submit a pull request <https://sigfig.readthedocs.io/en/latest/roadmap.html#contribution-guide>`_

Thanks for downloading :)
