Metadata-Version: 2.1
Name: inflate
Version: 0.4
Summary: inflate lets you compute how much money is worth in different years
Home-page: https://github.com/mzjp2/inflate
Author: Zain Patel
Author-email: zain.patel06@gmail.com
License: UNKNOWN
Description: # :money_with_wings: inflate
        
        ![PyPI](https://img.shields.io/pypi/v/inflate.svg?style=flat-square)
        ![License](https://img.shields.io/github/license/mzjp2/inflation.svg?style=flat-square)
        [![Code Style: Black](https://img.shields.io/badge/code-black-black.svg?style=flat-square)](https://github.com/ambv/black)
        [![Downloads](https://pepy.tech/badge/inflate)](https://pepy.tech/project/inflate?style=flat)
        
        inflate is a Python built command line interface that lets you quickly compute how inflation affects a sum of money in an intuitive and visually pleasing package.
        
        ## Installation
        
        Run ``pip install inflate``. Verify that the latest version is installed by running ``inflate --version``.
        
        ## Usage
        
        ```shell
        >>> inflate [OPTIONS] START END [AMOUNT]
            [AMOUNT] in [START] is worth [INFLATED AMOUNT] in [END] ([INCLUSIVE/EXCLUSIVE])
        ```
        The options are
        
        ```
          -c, --country TEXT  Country [either US/UK], default is UK
          -i, --inclusive     Include ending year, default no
          -a, --average       Show average annualised inflation, default no
          --version           Show the version and exit.
          --help              Show this message and exit.
        ```
        
        **Example**: 
        
        ```shell
        >>> inflate -c US -i 1998 1999 50
            $50.0 in 1998 is worth $51.51 in 1999 (inclusive).
        >>> inflate -a 1998 2000 50
        		£50.0 in 1998 is worth £51.46 in 2000 (exclusive). The average inflation across this period was 1.46%.
        ```
        
        ## Current features
        
        - [x] Able to work "backwards", that is, if you want to know how much $10 in 2018 was worth in 2000, you can do so via ``inflate -c US 2018 2000 10``
        - [x] Package and publish on PyPI.
        
        ## Future features/work
        
        - [ ] Add in a more detailed analytics view, showing average inflation across time period.
        - [ ] Flesh out the testing modules
        
Keywords: money command line interface inflation cli
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
