https://github.com/ibz-04/geolib
A Geometry package for manipulating two - dimensional shapes built on python
https://github.com/ibz-04/geolib
geometry geometry-processing open-source open-source-contribution python python-3 python-geometry-library python-libraries python-library python-math python-math-library python-open-source python-packages python3
Last synced: 6 months ago
JSON representation
A Geometry package for manipulating two - dimensional shapes built on python
- Host: GitHub
- URL: https://github.com/ibz-04/geolib
- Owner: iBz-04
- License: mit
- Created: 2024-08-19T12:57:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-25T17:44:06.000Z (over 1 year ago)
- Last Synced: 2025-06-27T05:43:00.908Z (6 months ago)
- Topics: geometry, geometry-processing, open-source, open-source-contribution, python, python-3, python-geometry-library, python-libraries, python-library, python-math, python-math-library, python-open-source, python-packages, python3
- Language: Python
- Homepage: https://geolib-docs-main.netlify.app/
- Size: 2.17 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GeoLib
This library is a new Python-based geometry package designed to facilitate easy manipulation of shapes. The initial version of the library primarily focuses on two fundamental shapes: Squares and Triangles. The project aims to be both educational and practical, making it useful for developers, students.
GeoLib is open-source under the MIT License, allowing developers to freely use, modify, and contribute to its ongoing development.
## Features
- Initialization with Side Length: Easily create a shape by specifying its side length.
- Area Calculation: Compute the area of the square using the area property.
- Perimeter Calculation: Compute the perimeter of the square using the perimeter property.
- Scaling: Scale the square by a given factor using the scale method, which allows for dynamic resizing of the square.
- Comparison Operators: Compare two squares using equality (==) and less than (<) operators based on their side lengths.
- Property Validation: Ensure that side lengths are positive, with robust error handling to prevent invalid geometric states.
- String Representation: Convenient string representation of the square, making it easy to display in output and debugging.
- The library is designed to be extensible, allowing developers to easily add support for additional geometric shapes beyond squares and triangles.
## Installation
Install the library with :
```bash
pip install git+https://github.com/iBz-04/GeoLib.git
```
## Usage
```python
from geolib import Square
# Create a square with a side length of 4
square = Square(4)
# Calculate area and perimeter
print("Area:", square.area) # Output: Area: 16
print("Perimeter:", square.perimeter) # Output: Perimeter: 16
# Scale the square by a factor of 2
square.scale(2)
print("New side length:", square.side_length) # Output: New side length: 8
# Compare squares
small_square = Square(3)
print(square > small_square) # Output: True
```
## Documentation
for more, see visit
[Geolib Documentation](https://geolib-docs-main.netlify.app/)
## Support
For support visit :
[Discussions](https://github.com/iBz-04/GeoLib/discussions)
## License
GeoLib is licensed under the [MIT](https://github.com/iBz-04/GeoLib?tab=MIT-1-ov-file#readme) License.
## Creators
- [@Ibrahim](https://github.com/iBz-04)
- [@Arda](https://github.com/cyrekWei)