Metadata-Version: 2.1
Name: malee
Version: 0.0.4
Summary: Malee
Home-page: https://malee.readthedocs.io
Author: Reza Behzadpour
Maintainer: Reza Behzadpour
Maintainer-email: reza.behzadpour1993@gmail.com
License: BSD 3-Clause
Download-URL: https://pypi.org/project/malee/
Project-URL: Bug Tracker, https://github.com/RezaBehzadpour/malee/issues
Project-URL: Documentation, https://malee.readthedocs.io
Project-URL: Source Code, https://github.com/RezaBehzadpour/malee
Description: [![Build Status](https://travis-ci.com/RezaBehzadpour/malee.svg?branch=master)](https://travis-ci.com/RezaBehzadpour/malee)
        [![codecov](https://codecov.io/gh/RezaBehzadpour/malee/branch/master/graph/badge.svg?token=nB6VHgh6bg)](https://codecov.io/gh/RezaBehzadpour/malee)
        [![Documentation Status](https://readthedocs.org/projects/malee/badge/?version=latest)](https://malee.readthedocs.io/en/latest/?badge=latest)
        ![PyPI](https://img.shields.io/pypi/v/malee)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/malee)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        # Malee
        The `malee` package contains a collection of financial modeling functions.
        
        The major goal of this package is to provide you an easy to use library that implements most of the financial modeling formulas like risk and return ready to be used. This package is using `numpy` as its backend so everything is fast enough as you might expect. There are similar projects like [`numpy-financial`][1], but most of the have these two problems of 1) not having everything you might need 2) not being maintained actively. Hence this packages aims to fill this gap and be your goto library when you want financial modeling stuff.
        
        `malee` in Farsi means *Financial*. Tried so many other cool names, but I was late in the game
        and they were already taken.
        
        The source code of this package is available at https://github.com/RezaBehzadpour/malee
        
        ## Install
        To install the current release of `malee`, type the following command in terminal:
        ```bash
        $ pip install -U malee
        ```
        
        ## How to use?
        Here's how you can calculate simple **Arithmetic Return**:  
        ```python
        >>> import malee
        >>> malee.ar(100, 140)
        0.4
        ```
        
        For more information, see the [documentation](https://malee.readthedocs.io).
        
        ## License
        [BSD 3-Clause](LICENSE)
        
        [1]: https://github.com/numpy/numpy-financial
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
Requires-Python: >=3.5
Description-Content-Type: text/markdown
