Metadata-Version: 2.4
Name: calculator_pkg_ex
Version: 0.11.0
Summary: Calculator Package Demo
Author-email: Justin Furuness <jfuruness@gmail.com>
Maintainer-email: Justin Furuness <jfuruness@gmail.com>
License: Copyright 2025 Justin Furuness
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/jfuruness/calculator_pkg_ex
Project-URL: Documentation, https://github.com/jfuruness/calculator_pkg_ex/
Keywords: calculator_pkg_ex,Python Packaging,Template,Calculator,Furuness
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: MacOS :: MacOS X
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: tqdm~=4.0
Provides-Extra: test
Requires-Dist: tox==4.32.0; extra == "test"
Requires-Dist: pytest==9.0.2; extra == "test"
Requires-Dist: mypy==1.19.1; extra == "test"
Requires-Dist: ruff==0.14.10; extra == "test"
Requires-Dist: pre-commit==4.5.1; extra == "test"
Requires-Dist: types-tqdm==4.67.0.20250809; extra == "test"
Dynamic: license-file

Informational Badges:

[![PyPI version](https://badge.fury.io/py/calculator_pkg_ex.svg)](https://badge.fury.io/py/calculator_pkg_ex)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/calculator_pkg_ex)](https://pypi.org/project/calculator_pkg_ex/)
![Tests](https://github.com/jfuruness/calculator_pkg_ex/actions/workflows/tests.yml/badge.svg)
![Linux](https://img.shields.io/badge/os-Linux-blue.svg)
![macOS Intel](https://img.shields.io/badge/os-macOS_Intel-lightgrey.svg)
![macOS ARM](https://img.shields.io/badge/os-macOS_ARM-lightgrey.svg)

Some Linting Badges (Where I could find them):

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Checked with mypy](https://img.shields.io/badge/mypy-checked-2A6DBA.svg)](http://mypy-lang.org/)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint/tree/main)
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)

# calculator\_pkg\_ex


### If you like the repo, it would be awesome if you could add a star to it! It really helps out the visibility. Also for any questions at all we'd love to hear from you at jfuruness@gmail.com

* [Description](#package-description)
* [Usage](#usage)
* [Installation](#installation)
* [Testing](#testing)
* [Development/Contributing](#developmentcontributing)
* [Licence](#license)

## Package Description

Calculator Python Package Example/Template

## Usage
* [calculator\_pkg\_ex](#calculator\_pkg\_ex)

from a script:

```python
from calculator_pkg_ex import Calculator
print(Calculator().add(1, 2))
```

## Installation
* [calculator\_pkg\_ex](#calculator\_pkg\_ex)

Install python and pip if you have not already.

Then run:

```bash
pip3 install pip --upgrade
pip3 install wheel
```

For production:

```bash
pip3 install calculator_pkg_ex
```

This will install the package and all of it's python dependencies.

If you want to install the project for development:
```bash
git clone https://github.com/jfuruness/calculator_pkg_ex.git
cd calculator_pkg_ex
pip3 install -e ".[test]"
pre-commit install
```

To test the development package: [Testing](#testing)


## Testing
* [calculator\_pkg\_ex](#calculator\_pkg\_ex)

To test the package after installation:

```
cd calculator_pkg_ex
pytest calculator_pkg_ex
ruff check calculator_pkg_ex
ruff format calculator_pkg_ex
mypy calculator_pkg_ex
```

If you want to run it across multiple environments:

```
cd calculator_pkg_ex
tox --skip-missing-interpreters
```


## Development/Contributing
* [calculator\_pkg\_ex](#calculator\_pkg\_ex)

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Test it
5. Run tox
6. Commit your changes: `git commit -am 'Add some feature'`
7. Push to the branch: `git push origin my-new-feature`
8. Ensure github actions are passing tests
9. Email me at jfuruness@gmail.com if it's been a while and I haven't seen it

## License
* [calculator\_pkg\_ex](#calculator\_pkg\_ex)

MIT License (see license file)
