Metadata-Version: 2.1
Name: amortizer
Version: 0.0.3
Summary: Simple package for generating loan amortization table and summary
Home-page: https://github.com/vlntsolo/amortizer
Author: Valentine Solonechnyi
Author-email: valentinesolo@gmail.com
License: UNKNOWN
Description: <div align="center">
        
        [![ReadTheDocs](https://readthedocs.org/projects/amortizer/badge/?version=latest)](https://amortizer.readthedocs.io/en/latest/?badge=latest)
        
        </div>
        
        # Amortizer - Simple loan amortization calculator
        
        *Amortizer* is a simple amortization table generator which supports two common approaches: annuity payments and straight amortization. 
        
        
        ## Overview
        
        *Amortizer* is basically a single python class which instantiates an object with several useful methods.
        
        | Method | Description |
        | ---- | --- |
        | **.get_summary(method="annuity")** | Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns a dictionary with summary statistics. |
        | **.straight_amortization()** | Calculates amortization table with straight amortization and returns a dataframe. |
        | **.annuity_amortization()** | Calculates amortization table with annuity payments and returns a dataframe. |
        | **.to_html(method="annuity")** | Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns results to a string with html markup. |
        | **.to_json(method="annuity")** | Calculates amortization dataframe (methods: 'straight' or 'annuity') and returns results to a string with JSON object. |
        | **.to_csv(path: str, method="annuity")** | Calculates amortization dataframe (methods: 'straight' or 'annuity') and exports results to the .csv file. |
        
        Learn more about the methods above in the [Documentation][docs]
        
        # Installation 
        
        `Amortizer` supports python3.7 + environments.
        
        ```shell
        $ pip install --upgrade amortize
        ```
        
        or use **pipenv**
        
        ```shell
        $ pipenv install --upgrade amortize
        ```
        
        
        # Getting Started
        
        ## Minimal Example
        
        ```python
        from amortizer.generator import Amortizer
        
        # Instantiate new object with any suitable name and pass itinial parameters of the loan / mortgage
        amortizer = Amortizer(amount=100000, period=18, interest_rate=6)
        
        # Get summary statistics with annuity payments
        amortizer.get_summary(method="annuity")
        # >>> {'total_cost': 104817.06, 'average_interest_exp': 267.62, 'average_monthly_pmt': 5823.17, 'total_interest_exp': 4817.12}
        
        # Export amortization payments table to csv file
        amortizer.to_csv(path="/tmp/", method="straight")
        #>>> Data was recorded to straight_amortization.csv at the following location: /tmp/
        
        ```
        
        # Resources
        
        - [**PyPi**](https://pypi.org/project/amortizer)
        - [**Documentation**](https://amortizer.readthedocs.io/en/latest/)
        - [**Issue tracking**](https://github.com/vlntsolo/amortizer/issues)
        
        
        # Contributing
        
        Feel free to send merge requests.
        
        
        # If you've got questions
        
        1. [Read the docs][docs].
        2. [Look through the issues](https://github.com/vlnsolo/amortizer/issues).
        
        
        # License
        
        [MIT License](LICENSE).
        
        
        [docs]: https://amortizer.readthedocs.io/en/latest/amortizer.html
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.7
Description-Content-Type: text/markdown
