semvec/pypi-packages huggingface dataset:
shapearea 1.0.0
Simple library for finding the areas of various shapes.
License: MIT
Requires Python: >=3.7
Keywords: shapearea,shape,area,math

# shapearea

[![PyPI Version](https://img.shields.io/pypi/v/shapearea.svg?style=flat)](https://pypi.org/project/shapearea/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/shapearea.svg?style=flat)](https://pypi/org/project/shapearea/) [![License](https://img.shields.io/pypi/l/shapearea.svg?style=flat)](LICENSE)

Simple library for finding the areas of various shapes.

## Installation

**PyPI**

```bash
$ pip install shapearea
```

**GitHub**

```bash
$ git clone https://github.com/mrwolferinc/shapearea.git
$ cd shapearea
$ python setup.py install
```

## Usage

To find the area of a square:

```python
>>> import shapearea as area
>>> area.square(5)
25
```

To find the area of a rectangle:

```python
>>> import shapearea as area
>>> area.rectangle(4, 2)
8
```

To find the area of a triangle:

```python
>>> import shapearea as area
>>> area.triangle(8, 3)
12.0
```

To find the area of a circle:

```python
>>> import shapearea as area
>>> area.circle(12)
452.3893421169302
```

---

Methods for finding the areas of ellipses, trapezoids, parallelograms, rhombi, kites, and equilateral triangles are also available and are documented on the [wiki](https://github.com/mrwolferinc/shapearea/wiki).

## Testing

Tests are located inside the `tests` directory and are run using [pytest](https://github.com/pytest-dev/pytest):

```bash
$ pytest tests/
```

## Contributing

See [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## License

MIT

**Yay, free software!**