Metadata-Version: 2.1
Name: amortization
Version: 1.0.0
Summary: Python library for calculating amortizations and generating amortization schedules
Home-page: https://github.com/roniemartinez/amortization
Author: Ronie Martinez
Author-email: ronmarti18@gmail.com
License: MIT
Download-URL: https://github.com/roniemartinez/amortization/tarball/1.0.0
Description: # amortization
        
        Python library for calculating amortizations and generating amortization schedules
        <table>
            <tr>
                <td>License</td>
                <td><img src='https://img.shields.io/pypi/l/amortization.svg'></td>
                <td>Version</td>
                <td><img src='https://img.shields.io/pypi/v/amortization.svg'></td>
            </tr>
            <tr>
                <td>Travis CI</td>
                <td><img src='https://travis-ci.org/roniemartinez/amortization.svg?branch=master'></td>
                <td>AppVeyor</td>
                <td><img src='https://ci.appveyor.com/api/projects/status/qy2j7qutbx1fymuq/branch/master?svg=true'></td>
            </tr>
            <tr>
                <td>Coverage</td>
                <td><img src='https://codecov.io/gh/roniemartinez/amortization/branch/master/graph/badge.svg'></td>
                <td>Wheel</td>
                <td><img src='https://img.shields.io/pypi/wheel/amortization.svg'></td>
            </tr>
            <tr>
                <td>Status</td>
                <td><img src='https://img.shields.io/pypi/status/amortization.svg'></td>
                <td>Downloads</td>
                <td><img src='https://img.shields.io/pypi/dm/amortization.svg'></td>
            </tr>
            <tr>
                <td>Supported versions</td>
                <td><img src='https://img.shields.io/pypi/pyversions/amortization.svg'></td>
                <td>Implementation</td>
                <td><img src='https://img.shields.io/pypi/implementation/amortization.svg'></td>
            </tr>
        </table>
        
        ## Demo
        
        [Amortization Calculator](https://apps.easyaspy.org/amortization-calculator)
        
        ## Install
        
        ```bash
        pip install amortization
        ```
        
        ### To build using Cython
        
        ```bash
        pip install cython
        pip install amortization
        ```
        
        ## Usage
        
        ### Python
        
        #### Amortization Amount
        
        ```python
        from amortization.amount import calculate_amortization_amount
        
        amount = calculate_amortization_amount(150000, 0.1, 36)
        ```
        
        ### Amortization Schedule
        
        ```python
        from amortization.schedule import amortization_schedule
        
        for number, amount, interest, principal, balance in amortization_schedule(150000, 0.1, 36):
            print(number, amount, interest, principal, balance)
        ```
        
        ### Amortization Schedule (using tabulate)
        
        ```python
        from amortization.schedule import amortization_schedule
        from tabulate import tabulate
        
        table = (x for x in amortization_schedule(150000, 0.1, 36))
        print(
            tabulate(
                table,
                headers=["Number", "Amount", "Interest", "Principal", "Balance"],
                floatfmt=",.2f",
                numalign="right"
            )
        )
        ```
        
        ### Command line
        
        ```bash
        amortize -h
        usage: amortize [-h] -P PRINCIPAL -n PERIOD -r INTEREST_RATE [-s]
        
        Python library for calculating amortizations and generating amortization
        schedules
        
        optional arguments:
          -h, --help            show this help message and exit
          -s, --schedule        Generate amortization schedule
        
        required arguments:
          -P PRINCIPAL, --principal PRINCIPAL
                                Principal amount
          -n PERIOD, --period PERIOD
                                Total number of periods
          -r INTEREST_RATE, --interest-rate INTEREST_RATE
                                Interest rate per period
        ```
        
        ```bash
        amortize -P 150000 -n 36 -r 0.1 -s
        ```
        
        ## Dependencies
        
        - [tabulate](https://bitbucket.org/astanin/python-tabulate)
        
        ## Author
        
        [Ronie Martinez](mailto:ronmarti18@gmail.com)
        
        ## References
        
        - [Packaging and distributing projects](https://packaging.python.org/guides/distributing-packages-using-setuptools/)
        - [Using TestPyPI](https://packaging.python.org/guides/using-testpypi/)
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
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.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
