Metadata-Version: 2.1
Name: kalkon
Version: 0.2.0
Summary: Calculator with GUI
Author-email: Fredrik Andersson <freand@gmail.com>
Maintainer-email: Fredrik Andersson <freand@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2023-2024, Fredrik Andersson
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/freand76/kalkon
Keywords: calculator
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyside6>=6.6.0
Requires-Dist: pexpect==4.8.0
Requires-Dist: asteval==0.9.31

# Kalkon - /kalˈkuːn/

*Swedish Noun*

*1. a turkey; a kind of large bird (colloquial)*

*2. a turkey; a failure*

*3. a python/asteval based calculator*

<p align="center">
  <img alt="Kalkon" src="https://raw.githubusercontent.com/freand76/kalkon/09cf8aa94aaf30b82a9e00e68c696bd3865af394/src/kalkon/images/kalkon.png" width=50%>
</p>

## Quickstart

### Install from PyPi
```
pip3 install kalkon
```

### Install from GitHub
```
> git clone https://github.com/freand76/kalkon.git
> cd kalkon
> python3 -m pip install .
```

### Start

Start using python.

```
> python3 -m kalkon
```

Start using shell script (if the pip3 bin-folder is in your path).

```
> kalkon
```

## Calculator

<p align="center">
  <img alt="Kalkon" src="https://raw.githubusercontent.com/freand76/kalkon/09cf8aa94aaf30b82a9e00e68c696bd3865af394/images/screenshot.png">
</p>

### Asteval

The calculator uses the [asteval](https://pypi.org/project/asteval) package to evaluate expressions.

Asteval handles python-like expression and will obey python rules for arithmetic and logic operators.

*Example*
```python
int(sin(pi/3)*log(5) + 0xfe) & 0x23
```

Asteval also handles variables, i.e. you can give variable a value and use it for later calculations.

*Example: Set variable*
```python
foo=3
```

*Example: Use variable*
```python
10 + foo * 5
```

### Commands

All commands start with a colon character
*Example:* **:hex**

**Output format commands**

The calculator can show the result of the expression in several different modes, enter one of the following commands to switch to the desired mode.

| Command | Description |
| :------ | :---------- |
| :float  | Show results as floating point |
| :f32    | Show results as 32-bit float / ieee-754 |
| :int    | Show results as integer, floats will be truncated |
| :i8"    | Show results as signed 8-bit integer |
| :i16    | Show results as signed 16-bit integer |
| :i32    | Show results as signed 32-bit integer |
| :i64    | Show results as signed 64-bit integer |
| :u8     | Show results as unsigned 8-bit integer |
| :u16    | Show results as unsigned 16-bit integer |
| :u32    | Show results as unsigned 32-bit integer |
| :u64    | Show results as unsigned 64-bit integer |
| :dec    | Show results as decimal values |
| :hex    | Show results as hexadecimal values |
| :bin    | Show results as binary values |


**Control commands**

The following command will clear the calculator stack.

| Command | Description |
| :------ | :---------- |
| :clear  | Clear the calculator stack |

### Shortcuts

| Shortcut | Description |
| :------- | :---------- |
| Shift+Enter | Drop stack item to editable field |
