Skip to content

FacetFlow: A Python library built for easy and extendable geometric shape computations. Calculate areas for core shapes like triangles and circles out of the box, or extend functionality by creating your own shape script. Join our community and contribute your own shape calculations!

License

Notifications You must be signed in to change notification settings

NilaierMusic/FacetFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FacetFlow Logo

FacetFlow

FacetFlow is a comprehensive Python library for calculating areas of various geometric shapes with incredible ease. The library comes with core calculations for common shapes like triangle and circle, but is designed with extensibility in mind — allowing you to whip up your own scripts for additional shapes as needed.

Contents

  1. Description
  2. Installation
  3. Usage
  4. Tests
  5. Contribute

Description

FacetFlow provides a set of tools for performing area calculations on different geometric shapes. It's an ideal library for tasks which require a high level of precision and a wide range of shape options. The library includes built-in classes for common shapes, and can easily be extended to include additional shapes. These scripts can be contributed back to the project to broaden our shape library further, or kept for specific use cases — the choice is yours.

Installation

To start using FacetFlow:

  1. Ensure Python is installed on your system
  2. Download the library from our Github repository.
  3. Navigate to the library directory and run the setup.py script:
$ python setup.py install

Usage

Import the shape classes from the module and create instances of the shapes you wish to calculate.

E.g., to calculate the area of a circle and a triangle:

from shapes.circle import Circle
from shapes.triangle import Triangle

c = Circle(10) # radius
t = Triangle(3,4,5) # sides

print(c.area())
print(c.perimeter())

print(t.area())
print(t.perimeter())

Tests

A comprehensive test suite is included with FacetFlow. To run the tests, use the provided AsciiTestRunner:

$ python test.py

Contribute

Contributions to extend the shape library in FacetFlow are welcomed. If you've created a script for a geometric shape, consider making a pull request on our Github page so others in the community can utilize it.

About

FacetFlow: A Python library built for easy and extendable geometric shape computations. Calculate areas for core shapes like triangles and circles out of the box, or extend functionality by creating your own shape script. Join our community and contribute your own shape calculations!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages