PyLoan

https://pyloan.readthedocs.io/en/latest/
Admin
PyLoan is a Python package providing a lightweight and flexible tool for mortgage and loan...
Tokens:3,892
Snippets:67
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install PyLoan from PyPI

Source: https://pyloan.readthedocs.io/en/latest/_sources/installation.rst.txt

Use this command to install the latest stable version of PyLoan from the Python Package Index.

```bash
python -m pip install pyloan
```

--------------------------------

### Install PyLoan from Local Source

Source: https://pyloan.readthedocs.io/en/latest/_sources/installation.rst.txt

After cloning the repository, navigate to the PyLoan source code directory and run this command to install the package locally.

```bash
python -m pip install
```

--------------------------------

### Install PyLoan from PyPI

Source: https://pyloan.readthedocs.io/en/latest/installation.html

Use this command to install the latest stable version of PyLoan from the Python Package Index.

```bash
python -m pip install pyloan

```

--------------------------------

### Install PyLoan from Local Source

Source: https://pyloan.readthedocs.io/en/latest/installation.html

After cloning the repository, navigate to the PyLoan source code directory and run this command to install the package locally.

```bash
python -m pip install

```

--------------------------------

### Install PyLoan with Pip

Source: https://pyloan.readthedocs.io/en/latest/index.html

Install the PyLoan package from PyPI using pip. This is the standard method for adding PyLoan to your Python environment.

```bash
$
pip install pyloan

```

--------------------------------

### Define a Loan

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Initialize a Loan object with essential parameters like loan amount, interest rate, term, and start date. This sets up the basic loan for calculations.

```python
loan = Loan(loan_amount=160000,interest_rate=1.1,loan_term=10,start_date='2020-06-15')
```

--------------------------------

### Clone PyLoan Source Code from GitHub

Source: https://pyloan.readthedocs.io/en/latest/_sources/installation.rst.txt

Clone the public repository to get the source code of PyLoan. This is useful for development or for installing directly from source.

```bash
git clone https://github.com/sudo-dakix/pyloan.git
```

--------------------------------

### Get Loan Summary

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Retrieve a summary of loan details including amounts, interest, and balances. The output is a dataclass object.

```python
payment_schedule = loan.get_loan_summary()
```

--------------------------------

### Get Loan Payment Schedule

Source: https://pyloan.readthedocs.io/en/latest/quickstart.html

Retrieve the payment schedule for a loan. The output is a list of dataclasses detailing each payment.

```python
payment_schedule = loan.get_payment_schedule()

```

--------------------------------

### Get Payment Schedule

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Retrieve the full payment schedule for a defined loan. This method returns a list of payment details, including dates, amounts, and balances.

```python
payment_schedule = loan.get_payment_schedule()
```

--------------------------------

### Import PyLoan Module

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Import the necessary Loan class from the PyLoan library to begin defining loans.

```python
from pyloan import Loan
```

--------------------------------

### Quarterly Loan Payments

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Configures a loan with quarterly payments. Ensure the 'annual_payments' argument is set to 4.

```python
loan = Loan(loan_amount=160000,interest_rate=1.1,loan_term=10,start_date='2020-06-15',payment_amount=888.33,annual_payments=4)
```

--------------------------------

### Define Loan with Specific Payment Amount

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Initialize a Loan object while specifying a fixed payment amount. This allows for custom amortization schedules where the payment is predetermined.

```python
loan = Loan(loan_amount=160000,interest_rate=1.1,loan_term=10,start_date='2020-06-15',payment_amount=888.33)
```

--------------------------------

### Summarize and Sort Day Count Method Comparison

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Summarize the results of comparing day count methods into a pandas DataFrame and sort them by total interest amount. This provides a clear overview of cost differences.

```python
loan_summary_df=pd.DataFrame(loan_summary,columns=['day_count_method','total_interest_amount'])
loan_summary_df.sort_values(by=['total_interest_amount'],ascending=False)
```

--------------------------------

### Compare Total Interest Paid Across Day Count Conventions

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Compare the total interest paid over a loan's lifetime using different day count conventions. This helps in selecting the most cost-effective method. Requires pandas.

```python
day_count_conventions=['30E/360 ISDA','30E/360','A/365','A/360','A/A']
loan_summary=list(map(lambda x:[x,Loan(loan_amount=160000,interest_rate=1.1,loan_term=10,start_date='2020-06-15',compounding_method=x).get_loan_summary().total_interest_amount],day_count_conventions))
```

--------------------------------

### Clone PyLoan Source Code from GitHub

Source: https://pyloan.readthedocs.io/en/latest/installation.html

Clone the public GitHub repository to obtain the source code for PyLoan.

```bash
git clone https://github.com/sudo-dakix/pyloan.git

```

--------------------------------

### Convert Loan Summary to Pandas DataFrame

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Convert the LoanSummary dataclass object to a pandas DataFrame for easier analysis and visualization. This is useful for comparing loan metrics.

```python
loan_summary = loan.get_loan_summary()
loan_summary_df=pd.DataFrame([loan_summary.__dict__])
```

--------------------------------

### Loan with Interest-Only Period (Months)

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Defines a loan with an interest-only period, specifying the loan term in months. The 'interest_only_period' argument sets the duration for interest-only payments.

```python
loan = Loan(loan_amount=160000,interest_rate=1.1,loan_term=120,loan_term_period='M',start_date='2020-06-15',interest_only_period=3)
```

--------------------------------

### Convert Payment Schedule to Pandas DataFrame

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Transform the list of payment dataclasses into a pandas DataFrame for easier analysis and visualization. This is useful for tabular data handling.

```python
data = [p.__dict__ for p in payment_schedule]
df=pd.DataFrame.from_records(data)
```

--------------------------------

### Loan with Interest-Only Period (Years)

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Defines a loan with an interest-only period. The 'interest_only_period' argument specifies the number of months for which only interest is paid.

```python
loan = Loan(loan_amount=160000,interest_rate=1.1,loan_term=10,start_date='2020-06-15',interest_only_period=3)
```

--------------------------------

### Add Special Payment to Loan

Source: https://pyloan.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Adds a special payment to the loan. Specify payment amount, date, term, and frequency. The 'special_payment_term_period' defaults to 'Y' for years.

```python
loan.add_special_payment(
  payment_amount=5000,
  first_payment_date='2021-03-17',
  special_payment_term=8,
  annual_payments=1,
  special_payment_term_period='Y'
  )
```
Tokens:
Raw