Metadata-Version: 2.4
Name: numpy-financial
Version: 1.1.0rc0
Summary: Simple financial functions
Author: Travis E. Oliphant et al.
Maintainer-Email: Numpy Financial Developers <numpy-discussion@python.org>
License-Expression: BSD-3-Clause
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Typing :: Typed
Requires-Python: >=3.13
Requires-Dist: numpy>=1.23.5
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Requires-Dist: hypothesis; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx>=7.0; extra == "doc"
Requires-Dist: numpydoc>=1.5; extra == "doc"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "doc"
Requires-Dist: myst-parser>=2.0.0; extra == "doc"
Provides-Extra: dev
Requires-Dist: spin; extra == "dev"
Requires-Dist: ruff>=0.11.5; extra == "dev"
Requires-Dist: asv>=0.6.0; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pyright; extra == "dev"
Description-Content-Type: text/markdown

# NumPy Financial

The `numpy-financial` package contains a collection of elementary financial
functions.

The [financial functions in NumPy](https://numpy.org/doc/1.17/reference/routines.financial.html)
are deprecated and eventually will be removed from NumPy; see
[NEP-32](https://numpy.org/neps/nep-0032-remove-financial-functions.html)
for more information.  This package is the replacement for the original
NumPy financial functions.

The source code for this package is available at https://github.com/numpy/numpy-financial.

The importable name of the package is `numpy_financial`.  The recommended
alias is `npf`.  For example,

```
>>> import numpy_financial as npf
>>> npf.irr([-250000, 100000, 150000, 200000, 250000, 300000])
0.5672303344358536
```

## Development

Test the package:

```
spin test -- --doctest-modules
```
