crdb-fee-calculator


Namecrdb-fee-calculator JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://github.com/yourusername/crdb_fee_calculator
SummaryA command line tool for calculating fees and VAT from CRDB account statements in Excel format
upload_time2025-08-20 09:52:58
maintainerNone
docs_urlNone
authorLeon Kasdorf
requires_python>=3.7
licenseMIT
keywords crdb fees vat excel banking tanzania accounting
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CRDB Fee Calculator

A command line tool for calculating fees and VAT from CRDB account statements in Excel format.

## Features

- 🚀 Simple command line interface
- 📊 Automatic detection of fees/charges
- 🏛️ VAT calculation
- 💱 **Automatic currency detection (USD/TZS)**
- 💰 Support for different currencies
- 🎨 Beautiful, formatted output
- 📁 Supports .xlsx and .xls files

## Installation

### From PyPI (Recommended)

```bash
pip install crdb-fee-calculator
```

### From Source

#### Requirements

- Linux system (Ubuntu 22.04+ recommended)
- Python 3.7 or higher
- python3-venv (will be installed automatically)

### Quick Installation

1. Clone or download repository
2. Make installation script executable:
   ```bash
   chmod +x install.sh
   ```
3. Run installation:
   ```bash
   ./install.sh
   ```

The tool will be automatically installed in `/usr/local/bin` and will be available from anywhere.

**Note:** This installation method is for development/testing. For production use, install from PyPI.

### Manual Installation

1. Create virtual environment:
   ```bash
   python3 -m venv venv
   source venv/bin/activate
   ```

2. Install dependencies:
   ```bash
   pip install -r requirements.txt
   ```

3. Make script executable and copy to PATH:
   ```bash
   chmod +x crdbfee.py
   sudo cp crdbfee.py /usr/local/bin/crdbfee
   ```

**Note:** The automated installation script is recommended as it handles virtual environment setup automatically.

## Usage

### Basic Usage

```bash
crdbfee statement.xlsx
```

### Show Help

```bash
crdbfee --help
```

### Show Version

```bash
crdbfee --version
```

## Example Output

### USD Output
```
╔══════════════════════════════════════════════════════════════╗
║                    CRDB Fee Calculator                      ║
╠══════════════════════════════════════════════════════════════╣
║  📊  Fees/Charges:          125.50 USD                     ║
║  🏛️   VAT Total:             25.10 USD                     ║
╠══════════════════════════════════════════════════════════════╣
║  💰  Total Amount:          150.60 USD                     ║
╚══════════════════════════════════════════════════════════════╝
💱 Detected currency: USD
```

### TZS Output
```
╔══════════════════════════════════════════════════════════════╗
║                    CRDB Fee Calculator                      ║
╠══════════════════════════════════════════════════════════════╣
║  📊  Fees/Charges:        25000.00 TZS                     ║
║  🏛️   VAT Total:           5000.00 TZS                     ║
╠══════════════════════════════════════════════════════════════╣
║  💰  Total Amount:        30000.00 TZS                     ║
╚══════════════════════════════════════════════════════════════╝
💱 Detected currency: TZS
```

## Uninstallation

```bash
chmod +x uninstall.sh
./uninstall.sh
```

## Supported File Formats

- Excel (.xlsx)
- Excel (.xls)

## Detection of Fees and VAT

The tool automatically detects:

**Fees/Charges:**
- charge
- commission
- fee
- levy
- fund transfer

**VAT:**
- All entries with "vat" in the description text

## Currency Detection

The tool automatically detects the currency from:
- Column names (e.g., "Balance USD", "Amount TZS")
- Description texts (e.g., "Bank Fee USD", "Commission TZS")
- Currency symbols ($, TSH, TZS)
- Fallback: USD (default)

**Supported Currencies:**
- **USD**: US Dollar
- **TZS**: Tanzania Shilling

## Troubleshooting

### "File does not exist"
- Check the file path
- Make sure the file is in the current directory

### "Not an Excel file"
- Use only .xlsx or .xls files
- Make sure the file is not corrupted

### "Python not found"
- Install Python 3.7 or higher
- Make sure `python3` is available in PATH

### "externally-managed-environment" Error (Ubuntu 22.04+)
- This error occurs because Ubuntu prevents system-wide pip installations
- The installation script automatically creates a virtual environment to solve this
- If you encounter this error, use the provided `install.sh` script instead of manual pip installation

## License

See [LICENSE](LICENSE) file for details.

## Support

For problems or questions, please create an issue in the repository.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/yourusername/crdb_fee_calculator",
    "name": "crdb-fee-calculator",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Leon Kasdorf <crdbfee@dropalias.com>",
    "keywords": "crdb, fees, vat, excel, banking, tanzania, accounting",
    "author": "Leon Kasdorf",
    "author_email": "Leon Kasdorf <crdbfee@dropalias.com>",
    "download_url": "https://files.pythonhosted.org/packages/b4/29/e8278fe0030c7693e90cf5d5f377b6c3adb82d168cade93714751ac7a788/crdb_fee_calculator-1.0.2.tar.gz",
    "platform": null,
    "description": "# CRDB Fee Calculator\n\nA command line tool for calculating fees and VAT from CRDB account statements in Excel format.\n\n## Features\n\n- \ud83d\ude80 Simple command line interface\n- \ud83d\udcca Automatic detection of fees/charges\n- \ud83c\udfdb\ufe0f VAT calculation\n- \ud83d\udcb1 **Automatic currency detection (USD/TZS)**\n- \ud83d\udcb0 Support for different currencies\n- \ud83c\udfa8 Beautiful, formatted output\n- \ud83d\udcc1 Supports .xlsx and .xls files\n\n## Installation\n\n### From PyPI (Recommended)\n\n```bash\npip install crdb-fee-calculator\n```\n\n### From Source\n\n#### Requirements\n\n- Linux system (Ubuntu 22.04+ recommended)\n- Python 3.7 or higher\n- python3-venv (will be installed automatically)\n\n### Quick Installation\n\n1. Clone or download repository\n2. Make installation script executable:\n   ```bash\n   chmod +x install.sh\n   ```\n3. Run installation:\n   ```bash\n   ./install.sh\n   ```\n\nThe tool will be automatically installed in `/usr/local/bin` and will be available from anywhere.\n\n**Note:** This installation method is for development/testing. For production use, install from PyPI.\n\n### Manual Installation\n\n1. Create virtual environment:\n   ```bash\n   python3 -m venv venv\n   source venv/bin/activate\n   ```\n\n2. Install dependencies:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n3. Make script executable and copy to PATH:\n   ```bash\n   chmod +x crdbfee.py\n   sudo cp crdbfee.py /usr/local/bin/crdbfee\n   ```\n\n**Note:** The automated installation script is recommended as it handles virtual environment setup automatically.\n\n## Usage\n\n### Basic Usage\n\n```bash\ncrdbfee statement.xlsx\n```\n\n### Show Help\n\n```bash\ncrdbfee --help\n```\n\n### Show Version\n\n```bash\ncrdbfee --version\n```\n\n## Example Output\n\n### USD Output\n```\n\u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557\n\u2551                    CRDB Fee Calculator                      \u2551\n\u2560\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2563\n\u2551  \ud83d\udcca  Fees/Charges:          125.50 USD                     \u2551\n\u2551  \ud83c\udfdb\ufe0f   VAT Total:             25.10 USD                     \u2551\n\u2560\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2563\n\u2551  \ud83d\udcb0  Total Amount:          150.60 USD                     \u2551\n\u255a\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255d\n\ud83d\udcb1 Detected currency: USD\n```\n\n### TZS Output\n```\n\u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557\n\u2551                    CRDB Fee Calculator                      \u2551\n\u2560\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2563\n\u2551  \ud83d\udcca  Fees/Charges:        25000.00 TZS                     \u2551\n\u2551  \ud83c\udfdb\ufe0f   VAT Total:           5000.00 TZS                     \u2551\n\u2560\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2563\n\u2551  \ud83d\udcb0  Total Amount:        30000.00 TZS                     \u2551\n\u255a\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255d\n\ud83d\udcb1 Detected currency: TZS\n```\n\n## Uninstallation\n\n```bash\nchmod +x uninstall.sh\n./uninstall.sh\n```\n\n## Supported File Formats\n\n- Excel (.xlsx)\n- Excel (.xls)\n\n## Detection of Fees and VAT\n\nThe tool automatically detects:\n\n**Fees/Charges:**\n- charge\n- commission\n- fee\n- levy\n- fund transfer\n\n**VAT:**\n- All entries with \"vat\" in the description text\n\n## Currency Detection\n\nThe tool automatically detects the currency from:\n- Column names (e.g., \"Balance USD\", \"Amount TZS\")\n- Description texts (e.g., \"Bank Fee USD\", \"Commission TZS\")\n- Currency symbols ($, TSH, TZS)\n- Fallback: USD (default)\n\n**Supported Currencies:**\n- **USD**: US Dollar\n- **TZS**: Tanzania Shilling\n\n## Troubleshooting\n\n### \"File does not exist\"\n- Check the file path\n- Make sure the file is in the current directory\n\n### \"Not an Excel file\"\n- Use only .xlsx or .xls files\n- Make sure the file is not corrupted\n\n### \"Python not found\"\n- Install Python 3.7 or higher\n- Make sure `python3` is available in PATH\n\n### \"externally-managed-environment\" Error (Ubuntu 22.04+)\n- This error occurs because Ubuntu prevents system-wide pip installations\n- The installation script automatically creates a virtual environment to solve this\n- If you encounter this error, use the provided `install.sh` script instead of manual pip installation\n\n## License\n\nSee [LICENSE](LICENSE) file for details.\n\n## Support\n\nFor problems or questions, please create an issue in the repository.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A command line tool for calculating fees and VAT from CRDB account statements in Excel format",
    "version": "1.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/yourusername/crdb_fee_calculator/issues",
        "Documentation": "https://github.com/yourusername/crdb_fee_calculator#readme",
        "Homepage": "https://github.com/yourusername/crdb_fee_calculator",
        "Repository": "https://github.com/yourusername/crdb_fee_calculator"
    },
    "split_keywords": [
        "crdb",
        " fees",
        " vat",
        " excel",
        " banking",
        " tanzania",
        " accounting"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "51caceaa27fd12a503f181b425f3433c18efd62c200e803f98e3489c323e4316",
                "md5": "2616a90207bf3565fe89903ce3c429e7",
                "sha256": "8647c26ce12d52a03dd839b1e1160af9ed456dd09de2d095efa90a4bc50b6586"
            },
            "downloads": -1,
            "filename": "crdb_fee_calculator-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2616a90207bf3565fe89903ce3c429e7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10446,
            "upload_time": "2025-08-20T09:52:57",
            "upload_time_iso_8601": "2025-08-20T09:52:57.298883Z",
            "url": "https://files.pythonhosted.org/packages/51/ca/ceaa27fd12a503f181b425f3433c18efd62c200e803f98e3489c323e4316/crdb_fee_calculator-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b429e8278fe0030c7693e90cf5d5f377b6c3adb82d168cade93714751ac7a788",
                "md5": "75a081829cb199c091cb90fbe91cb45e",
                "sha256": "220bf1bd5ddf5e16365dbac2d1d33df73afef9c12e7197e2fce60f792bc6a282"
            },
            "downloads": -1,
            "filename": "crdb_fee_calculator-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "75a081829cb199c091cb90fbe91cb45e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 16432,
            "upload_time": "2025-08-20T09:52:58",
            "upload_time_iso_8601": "2025-08-20T09:52:58.709608Z",
            "url": "https://files.pythonhosted.org/packages/b4/29/e8278fe0030c7693e90cf5d5f377b6c3adb82d168cade93714751ac7a788/crdb_fee_calculator-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 09:52:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yourusername",
    "github_project": "crdb_fee_calculator",
    "github_not_found": true,
    "lcname": "crdb-fee-calculator"
}
        
Elapsed time: 1.06065s