math-for-cannibals

Name	math-for-cannibals JSON
Version	2 JSON
	download
home_page	https://gitlab.com/hann1ba1/math-for-cannibals
Summary	Math functions to simplify mathematical tasks
upload_time	2024-11-10 11:32:41
maintainer	None
docs_url	None
author	Hannibal Lykke Kofoed
requires_python	None
license	MIT
keywords	python math mathematics
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Math for Cannibals
This Python package provides mathematical functions to automate calculations, particularly for right triangles.

## Table of Contents

1. [Installation](#installation)
2. [Practical Information](#practical-information)
3. [Usage](#usage)
4. [Contributing](#contributing)
5. [License](#license)

## Installation

To install the package, run the following command:

```bash
pip install math_for_cannibals
```

## Practical Information

When using the class, you will be prompted to provide values for `a`, `b`, and `c`. These values represent the sides and angles of a right triangle, defined as follows:  
![right_triangle](right_triangle.png)
If the image is not rendered, you can view it [here](https://gitlab.com/hann1ba1/math-for-cannibals/-/blob/master/README.md?ref_type=heads).

## Usage

### Table of Contents

1. [Configuring the Class](#configuring-the-class)
2. [Using the Class](#using-the-class)
3. [Retrieving Calculated Values](#retrieving-calculated-values)

### Configuring the Class
The class responsible for the calculations is configured like this:

```python
from math_for_cannibals.RightTriangle import RightTriangle

Rt = RightTriangle(aSide, bSide, cSide, aDegree, bDegree)
```

Here’s an example:
```python
Rt = RightTriangle(aDegree=20)
```

### Using the Class
You can use the class by entering the information you know about the triangle. The following are some example usages:

```python
Rt = RightTriangle(aDegree=20)
```

```python
Rt = RightTriangle(aSide=2, bSide=3)
```

```python
Rt = RightTriangle(aDegree=20, aSide=2)
```

### Retrieving Calculated Values
To get the calculated angles and sides of the triangle, you can use the following methods:

```python
Rt = RightTriangle(aDegree=20)
Rt.get_degrees()
```

The class has three main methods:  
- `get_degrees()` - Returns only the angles of the triangle.  
- `get_sides()` - Returns only the sides of the triangle.  
- `get_triangle()` - Returns both the sides and angles of the triangle.

## Contributing
Contributions are welcome! Please send an email explaining your proposed improvements to ensure clarity.  
Be sure to update tests as needed.

## License
[MIT](https://choosealicense.com/licenses/mit/)

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/hann1ba1/math-for-cannibals",
    "name": "math-for-cannibals",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "python, math, mathematics",
    "author": "Hannibal Lykke Kofoed",
    "author_email": "hanniballykkekofoed@icloud.com",
    "download_url": "https://files.pythonhosted.org/packages/e5/ed/b95a467ad1534167d35ff28e74d1cdf99d4cef39adaf2f2db0f85c7f1a25/math_for_cannibals-2.tar.gz",
    "platform": null,
    "description": "# Math for Cannibals\r\nThis Python package provides mathematical functions to automate calculations, particularly for right triangles.\r\n\r\n## Table of Contents\r\n\r\n1. [Installation](#installation)\r\n2. [Practical Information](#practical-information)\r\n3. [Usage](#usage)\r\n4. [Contributing](#contributing)\r\n5. [License](#license)\r\n\r\n## Installation\r\n\r\nTo install the package, run the following command:\r\n\r\n```bash\r\npip install math_for_cannibals\r\n```\r\n\r\n## Practical Information\r\n\r\nWhen using the class, you will be prompted to provide values for `a`, `b`, and `c`. These values represent the sides and angles of a right triangle, defined as follows:  \r\n![right_triangle](right_triangle.png)\r\nIf the image is not rendered, you can view it [here](https://gitlab.com/hann1ba1/math-for-cannibals/-/blob/master/README.md?ref_type=heads).\r\n\r\n## Usage\r\n\r\n### Table of Contents\r\n\r\n1. [Configuring the Class](#configuring-the-class)\r\n2. [Using the Class](#using-the-class)\r\n3. [Retrieving Calculated Values](#retrieving-calculated-values)\r\n\r\n### Configuring the Class\r\nThe class responsible for the calculations is configured like this:\r\n\r\n```python\r\nfrom math_for_cannibals.RightTriangle import RightTriangle\r\n\r\nRt = RightTriangle(aSide, bSide, cSide, aDegree, bDegree)\r\n```\r\n\r\nHere\u00e2\u20ac\u2122s an example:\r\n```python\r\nRt = RightTriangle(aDegree=20)\r\n```\r\n\r\n### Using the Class\r\nYou can use the class by entering the information you know about the triangle. The following are some example usages:\r\n\r\n```python\r\nRt = RightTriangle(aDegree=20)\r\n```\r\n\r\n```python\r\nRt = RightTriangle(aSide=2, bSide=3)\r\n```\r\n\r\n```python\r\nRt = RightTriangle(aDegree=20, aSide=2)\r\n```\r\n\r\n### Retrieving Calculated Values\r\nTo get the calculated angles and sides of the triangle, you can use the following methods:\r\n\r\n```python\r\nRt = RightTriangle(aDegree=20)\r\nRt.get_degrees()\r\n```\r\n\r\nThe class has three main methods:  \r\n- `get_degrees()` - Returns only the angles of the triangle.  \r\n- `get_sides()` - Returns only the sides of the triangle.  \r\n- `get_triangle()` - Returns both the sides and angles of the triangle.\r\n\r\n## Contributing\r\nContributions are welcome! Please send an email explaining your proposed improvements to ensure clarity.  \r\nBe sure to update tests as needed.\r\n\r\n## License\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Math functions to simplify mathematical tasks",
    "version": "2",
    "project_urls": {
        "Homepage": "https://gitlab.com/hann1ba1/math-for-cannibals"
    },
    "split_keywords": [
        "python",
        " math",
        " mathematics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ccb9c2982cad53fb6dfab3f4cf9751266592318ca2da70fdcc772038a2941312",
                "md5": "26e386ad8e46d2ff712e486dd59bcefe",
                "sha256": "71aa95242e0c130e06e1cef18f0e999fc62a8ef9e0ab2a1d1a7fccb61ddf7acc"
            },
            "downloads": -1,
            "filename": "math_for_cannibals-2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "26e386ad8e46d2ff712e486dd59bcefe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4704,
            "upload_time": "2024-11-10T11:32:39",
            "upload_time_iso_8601": "2024-11-10T11:32:39.610865Z",
            "url": "https://files.pythonhosted.org/packages/cc/b9/c2982cad53fb6dfab3f4cf9751266592318ca2da70fdcc772038a2941312/math_for_cannibals-2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5edb95a467ad1534167d35ff28e74d1cdf99d4cef39adaf2f2db0f85c7f1a25",
                "md5": "508e424583ed869b8f3d28e396116f5d",
                "sha256": "65d96cc515956703320f2095b722daa9f7a91f71fc50fa9c7730b8259f8e7889"
            },
            "downloads": -1,
            "filename": "math_for_cannibals-2.tar.gz",
            "has_sig": false,
            "md5_digest": "508e424583ed869b8f3d28e396116f5d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4387,
            "upload_time": "2024-11-10T11:32:41",
            "upload_time_iso_8601": "2024-11-10T11:32:41.340808Z",
            "url": "https://files.pythonhosted.org/packages/e5/ed/b95a467ad1534167d35ff28e74d1cdf99d4cef39adaf2f2db0f85c7f1a25/math_for_cannibals-2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-10 11:32:41",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "hann1ba1",
    "gitlab_project": "math-for-cannibals",
    "lcname": "math-for-cannibals"
}