syriantaxescli 0.1.2

Add your description here

syriantaxescli

A command-line tool for calculating and analyzing Syrian salary taxes, built with Typer and leveraging the syriantaxes library.

Features

• Gross and Net Salary Calculations: Compute taxes for a given gross salary or determine the required gross salary for a target net salary.
• Batch Calculations: Generate salary tables for a range of amounts.
• Export Results: Output results to Excel (.xlsx), JSON, or JSONL files.
• Rich CLI Output: Nicely formatted tables using rich.

Installation

pip install syriantaxescli

Usage

After installation, use the CLI tool:

sytax [COMMAND] [OPTIONS]

Commands

• gross: Calculate taxes for a given gross salary and compensations.
• net: Calculate gross salary and compensations for a given target net salary.
• ar: Generate salaries for a range of amounts (amount range).

Options

• Bracket configuration: --brackets-mins, --brackets-maxs, --brackets-rates
• Compensation rate: --compensations-rate
• Fixed tax rate, minimum allowed salary, social security options, and more.
• Output file: --write-path (supports .xlsx, .json, .jsonl)

Example

sytax gross --gross-salary 1000000 --compensations 100000
sytax net --target-salary 900000 --compensations-rate 0.1
sytax ar --start 800000 --stop 1200000 --step 50000 --compensations-rate 0.1 --write-path results.xlsx

Project Structure

• src/syriantaxescli/controllers.py: CLI entry point and command definitions.
• src/syriantaxescli/services.py: Core tax calculation logic.
• src/syriantaxescli/writers.py: Export utilities for Excel, JSON, and JSONL.
• src/syriantaxescli/tables.py: Table formatting for CLI output.
• src/syriantaxescli/schemas.py: Data models for salary and tax results.
• src/syriantaxescli/options.py, dependencies.py, constants.py, callbacks.py: CLI options, validation, and configuration.

Environment Variables

You can configure the CLI using the following environment variables:

Variable	Description
SYRIANTAXES_BRACKET_TAX_MINS	List of minimum values for each tax bracket.
SYRIANTAXES_BRACKET_TAX_MAXS	List of maximum values for each tax bracket.
SYRIANTAXES_BRACKET_TAX_RATES	List of tax rates for each bracket.
SYRIANTAXES_TAXES_ROUNDING_METHOD	Rounding method for taxes (see syriantaxes.RoundingMethod).
SYRIANTAXES_TAXES_ROUND_TO_NEAREST	Value to which taxes are rounded (e.g., 100, 1).
SYRIANTAXES_MIN_ALLOWED_SALARY	Minimum allowed gross salary for tax calculation.
SYRIANTAXES_FIXED_TAX_RATE	Fixed tax rate to apply (if applicable).
SYRIANTAXES_SS_ROUNDING_METHOD	Rounding method for social security calculations.
SYRIANTAXES_SS_ROUND_TO_NEAREST	Value to which social security deductions are rounded.
SYRIANTAXES_MIN_SS_ALLOWED_SALARY	Minimum allowed salary for social security calculations.
SYRIANTAXES_SS_DEDUCTION_RATE	Social security deduction rate.

Requirements

• Python 3.12+
• syriantaxes
• typer, typer-di, xlwings, rich

License

GNU General Public License v3 (GPLv3)