Metadata-Version: 1.2
Name: yearfrac
Version: 0.4.6
Summary: Daycount methods to compute date differences in year units
Home-page: http://github.com/kmedian/yearfrac
Author: Ulf Hamster
Author-email: 554c46@gmail.com
License: MIT
Description: |PyPI version| |yearfrac| |Total alerts| |Language grade: Python|
        |deepcode|
        
        yearfrac
        ========
        
        Installation
        ------------
        
        The ``yearfrac`` `git repo <http://github.com/kmedian/yearfrac>`__ is
        available as `PyPi package <https://pypi.org/project/yearfrac>`__
        
        ::
        
           pip install yearfrac
        
        Usage
        -----
        
        Check the
        `examples <https://github.com/kmedian/yearfrac/tree/master/examples>`__
        folder for notebooks.
        
        Functions
        
        -  ``isaleapyear`` – Check if a year is leap year
        -  ``eastersunday`` – Determine day and month of an Easter Sunday for a
           given year
        -  ``jd_to_date`` and ``date_to_jd`` – Julian Day number conversion
        -  ``act_afb`` – Actual/Actual AFB
        -  ``act_isda`` – Actual/Actual ISDA
        -  ``d30360e`` – 30E/360 ISDA daycount method
        -  ``d30365`` – 30/365 daycount method
        -  ``yearfrac`` – Wrapper for all daycount methods
        
        Appendix
        --------
        
        Install a virtual environment
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ::
        
           python3.6 -m venv .venv
           source .venv/bin/activate
           pip3 install --upgrade pip
           pip3 install -r requirements.txt
           pip3 install -r requirements-dev.txt
           pip3 install -r requirements-demo.txt
        
        (If your git repo is stored in a folder with whitespaces, then don’t use
        the subfolder ``.venv``. Use an absolute path without whitespaces.)
        
        Python Commands
        ~~~~~~~~~~~~~~~
        
        -  Check syntax:
           ``flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')``
        -  Run Unit Tests: ``python -W ignore -m unittest discover``
        -  Remove ``.pyc`` files: ``find . -type f -name "*.pyc" | xargs rm``
        -  Remove ``__pycache__`` folders:
           ``find . -type d -name "__pycache__" | xargs rm -rf``
        
        Publish
        
        .. code:: sh
        
           pandoc README.md --from markdown --to rst -s -o README.rst
           python setup.py sdist 
           twine upload -r pypi dist/*
        
        Support
        ~~~~~~~
        
        Please `open an
        issue <https://github.com/kmedian/yearfrac/issues/new>`__ for support.
        
        Contributors
        ~~~~~~~~~~~~
        
        -  Ivan Nesic [@fatkaratekid](https://github.com/fatkaratekid)
        -  Vinay Gupta [@vinschess](https://github.com/vinschess)
        -  Ulf Hamster [@ulf1](https://github.com/ulf1)
        
        Please contribute using `Github
        Flow <https://guides.github.com/introduction/flow/>`__. Create a branch,
        add commits, and `open a pull
        request <https://github.com/kmedian/yearfrac/compare/>`__.
        
        .. |PyPI version| image:: https://badge.fury.io/py/yearfrac.svg
           :target: https://badge.fury.io/py/yearfrac
        .. |yearfrac| image:: https://snyk.io/advisor/python/yearfrac/badge.svg
           :target: https://snyk.io/advisor/python/yearfrac
        .. |Total alerts| image:: https://img.shields.io/lgtm/alerts/g/kmedian/yearfrac.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/kmedian/yearfrac/alerts/
        .. |Language grade: Python| image:: https://img.shields.io/lgtm/grade/python/g/kmedian/yearfrac.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/kmedian/yearfrac/context:python
        .. |deepcode| image:: https://www.deepcode.ai/api/gh/badge?key=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwbGF0Zm9ybTEiOiJnaCIsIm93bmVyMSI6ImttZWRpYW4iLCJyZXBvMSI6InllYXJmcmFjIiwiaW5jbHVkZUxpbnQiOmZhbHNlLCJhdXRob3JJZCI6Mjk0NTIsImlhdCI6MTYxOTU0MjUyOX0.RI73MEmFUVlndzYdZq9l6ip2XozSJldBOhDHyIGsfwI
           :target: https://www.deepcode.ai/app/gh/kmedian/yearfrac/_/dashboard?utm_content=gh%2Fkmedian%2Fyearfrac
        
Platform: UNKNOWN
Requires-Python: >=3.6
