Metadata-Version: 2.4
Name: NiveshPy
Version: 0.1.0.dev0
Summary: A simple python library for all your investment needs.
Project-URL: Homepage, http://github.com/yashovardhan99/niveshpy
Project-URL: Repository, https://github.com/yashovardhan99/niveshpy.git
Project-URL: Issues, http://github.com/yashovardhan99/niveshpy/issues
Project-URL: Changelog, http://github.com/yashovardhan99/niveshpy/blob/master/CHANGELOG.md
Project-URL: funding, https://github.com/yashovardhan99/niveshpy
Project-URL: releasenotes, https://github.com/yashovardhan99/niveshpy/releases
Author-email: Yashovardhan Dhanania <yashovardhandhanania@gmail.com>
Maintainer-email: Yashovardhan Dhanania <yashovardhandhanania@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: finance,investment,mutual funds
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Requires-Dist: numpy<3.0.0,>=2.0.2
Requires-Dist: platformdirs<5.0.0,>=4.3.8
Requires-Dist: polars<2.0.0,>=1.29.0
Requires-Dist: scipy<2.0.0,>=1.13.1
Provides-Extra: all
Requires-Dist: pandas<3.0.0,>=2.2.2; extra == 'all'
Requires-Dist: pyarrow<21.0.0,>=20.0.0; extra == 'all'
Provides-Extra: pandas
Requires-Dist: pandas<3.0.0,>=2.2.2; extra == 'pandas'
Requires-Dist: pyarrow<21.0.0,>=20.0.0; extra == 'pandas'
Description-Content-Type: text/markdown

# NiveshPy

<!-- --8<-- [start:common-1] -->

NiveshPy is a financial library designed for managing mutual funds and investment portfolios. It provides functionalities to fetch fund prices, manage portfolios, and calculate performance.

<!-- --8<-- [end:common-1] -->

**Documentation**: [http://yashovardhan99.github.io/niveshpy](http://yashovardhan99.github.io/niveshpy)

NiveshPy is targeted towards Indian :india: markets, but the API is built in a way that any financial data can be added as a source. See [our guide on Plugins](http://yashovardhan99.github.io/niveshpy/plugins/) for more information.

<!-- --8<-- [start:common-2] -->

## Quick Start

To get started, install NiveshPy from [PyPi](https://pypi.org/project/NiveshPy/):

```sh
pip install niveshpy
```

After installing, you can simply start using NiveshPy:

```py
from niveshpy import Nivesh

app = Nivesh()

app.get_quotes(...)
```

## Work in progress

This project is a work in progress. The public API is still in development and unstable.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

<!-- --8<-- [end:common-2] -->