First commit

.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

README.md

@@ -0,0 +1,80 @@
+
+# Compound Interest Calculator
+
+This package provides a `CompoundInterestCalculator` class for calculating compound interest for various financial scenarios.
+
+## Features
+
+- Calculate the total amount with compound interest over a period of time.
+- Determine the time needed to reach a target amount with compound interest.
+- Calculate the required recurring deposit to reach a target amount.
+- Calculate the required interest rate to reach a target amount.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install compoundercalc
+```
+
+## Usage
+
+### Importing the Calculator
+
+```python
+from compoundercalc.compounder import CompoundInterestCalculator
+```
+
+### Creating an Instance
+
+```python
+calc = CompoundInterestCalculator(initial_deposit=1000, recurring_deposit=150, num_recurring_per_year=12, interest_rate=0.08)
+```
+
+### Calculating the Final Amount
+
+```python
+result = calc.final_amount(time_years=10)
+print(f"The final amount is: {result:.2f}")
+```
+
+### Determining the Time to Reach a Target Amount
+
+```python
+years, months, days = calc.time_goal(target_amount=100000)
+print(f"Time needed to reach the goal: {years} years, {months} months, and {days} days")
+```
+
+### Calculating the Required Recurring Deposit
+
+```python
+required_deposit = calc.calc_recurring_deposit(target_amount=100000, total_years=10)
+print(f"The required recurring deposit is: {required_deposit:.2f}")
+```
+
+### Calculating the Required Interest Rate
+
+```python
+try:
+    required_rate = calc.calc_interest_rate(target_amount=100000, total_years=10)
+    print(f"The required annual interest rate is: {required_rate:.4f}")
+except ValueError as e:
+    print(e)
+```
+
+## Running Tests
+
+To run the tests, use the following command:
+
+```bash
+python -m unittest discover -s test
+```
+
+## License
+
+This project is licensed under GNU License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

README.rst

@@ -0,0 +1,96 @@
+Compound Interest Calculator
+============================
+
+This package provides a ``CompoundInterestCalculator`` class for
+calculating compound interest for various financial scenarios.
+
+Features
+--------
+
+-  Calculate the total amount with compound interest over a period of
+   time.
+-  Determine the time needed to reach a target amount with compound
+   interest.
+-  Calculate the required recurring deposit to reach a target amount.
+-  Calculate the required interest rate to reach a target amount.
+
+Installation
+------------
+
+You can install the package using pip:
+
+.. code:: bash
+
+   pip install compoundercalc
+
+Usage
+-----
+
+Importing the Calculator
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   from compoundercalc.compounder import CompoundInterestCalculator
+
+Creating an Instance
+~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   calc = CompoundInterestCalculator(initial_deposit=1000, recurring_deposit=150, num_recurring_per_year=12, interest_rate=0.08)
+
+Calculating the Final Amount
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   result = calc.final_amount(time_years=10)
+   print(f"The final amount is: {result:.2f}")
+
+Determining the Time to Reach a Target Amount
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   years, months, days = calc.time_goal(target_amount=100000)
+   print(f"Time needed to reach the goal: {years} years, {months} months, and {days} days")
+
+Calculating the Required Recurring Deposit
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   required_deposit = calc.calc_recurring_deposit(target_amount=100000, total_years=10)
+   print(f"The required recurring deposit is: {required_deposit:.2f}")
+
+Calculating the Required Interest Rate
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   try:
+       required_rate = calc.calc_interest_rate(target_amount=100000, total_years=10)
+       print(f"The required annual interest rate is: {required_rate:.4f}")
+   except ValueError as e:
+       print(e)
+
+Running Tests
+-------------
+
+To run the tests, use the following command:
+
+.. code:: bash
+
+   python -m unittest discover -s test
+
+License
+-------
+
+This project is licensed under GNU License. See the
+`LICENSE <LICENSE>`__ file for details.
+
+Contributing
+------------
+
+Contributions are welcome! Please feel free to submit a Pull Request.