Metadata-Version: 2.1
Name: pymbs
Version: 0.0.2
Summary: A library for use in modeling Mortgage-Backed Securities.
Home-page: https://pypi.org/project/pymbs/
Author: Brian Farrell
Author-email: brian.farrell@me.com
License: AGPLv3
Keywords: financial modeling analysis mortgage securities
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Software Development :: Libraries
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.16.4)
Requires-Dist: pandas (>=0.25.0)


============
Introduction
============

PyMBS is a Python library for use in modeling Mortgage-Backed Securities.

    * This is a modern Python library that requires ``Python>=3.6``


Objectives
----------
#. Create a modern, stable Python library with a clearly-defined API  
#. Provide as close to 100% Test Coverage as possible [#f1]_
#. Provide clear documentation with full coverage of the API and example code.



Installing
----------

Install and update using `pip`:

.. code-block:: bash

   pip install -U pymbs


Links
-----

* Website: https://pypi.org/project/pymbs/
* Documentation: https://brianfarrell.gitlab.io/pymbs/
* License: https://www.gnu.org/licenses/agpl.html
* Releases: https://pypi.org/project/pymbs/
* Code: https://gitlab.trove.fm/btf/pymbs
* Issue tracker:
* Test status:
* Test coverage:

.. rubric:: Footnotes

.. [#f1] | This project started-out as a Proof of Concept (POC).
       | At that point, no automated testing was involved.
       | Going forward, all new development and bug fixes will be test-driven.


