gstpy 0.1.1

gstpy is a simple and flexible Python module that allows you to calculate GST (Goods and Services Tax) in both exclusive and inclusive modes. It provides the option to return results as list values (ideal for developers) or display them in a formatted tabular output (perfect for CLI and reports).

gstpy Module

   

The gstpy module provides an easy and flexible way to calculate GST (Goods and Services Tax) for various item formats such as lists, dictionaries, and integers. It supports both exclusive and inclusive tax calculations and presents the output in multiple formats: list, dictionary, or a well-formatted table using the tabulate package.    

Installation

   

You can install this module using pip:    

pip install gstpy

GST Class

  from gstpy import GST  

Constructor

    GST(items=0, rate=18, mode="exclusive")

Initializes a GST object.    

Parameters:

• items: (int, list, dict) — Item(s) to calculate GST on. Defaults to 0.
• rate: (int, float) — GST rate. Defaults to 18.
• mode: (str) — Either "exclusive" or "inclusive" to specify GST type. Defaults to "exclusive".    

Behavior:

• Automatically processes the provided items if valid.
• Supports multiple formats:
  • List of integers or tuples/lists
  • Dictionary with item names as keys and prices or [price, quantity] as values
  • Single integer price    

Methods

   

1. exclusive

   

Calculates GST using the exclusive method (GST is added to the price).    

Parameters:

• items: Items to calculate GST for (int, list, dict)
• rate: GST rate (int, float)
• out: Output format - "list", "dict", or "table"    

Returns:

• List or dictionary of results (if out is "list" or "dict")
• Table printed on screen (if out is "table")    

Format Supported:

• Single price (int)
• List of prices (list)
• List of [item_name, price]
• List of [item_name, price, qty]
• Dict of {item_name: price} or {item_name: [price, qty]}    

2. inclusive

   

Calculates GST using the inclusive method (price already includes GST).    

Parameters:

• items: Items to calculate GST for (int, list, dict)
• rate: GST rate (int, float)
• out: Output format - "list", "dict", or "table"    

Returns:

• List or dictionary of results (if out is "list" or "dict")
• Table printed on screen (if out is "table")    

Format Supported:

• Single price (int)
• List of prices (list)
• List of [item_name, price]
• List of [item_name, price, qty]
• Dict of {item_name: price} or {item_name: [price, qty]}    

Special Functions

   

• ingst(total_price, gst_rate) → returns only the GST amount
• exgst(base_price, gst_rate) → returns only the GST amount

Documentation

   

   

You can download the full documentation for the gstpy module by clicking the button above.

Author

   

Developed by: Ankush

• LinkedIn Profile
• GitHub Profile
     

For any issues or bug reports, please open an issue on GitHub.