Metadata-Version: 2.1
Name: Points-cli
Version: 0.1.1
Summary: Plots and measures angles and distances between points in 3-Dimensions
Home-page: https://github.com/Ridhiwan/Points-cli
Author: Ridhiwan Ramadhan Mseya
Author-email: ridhiwanmseya@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: tqdm


POINTS-CLI
----------
Use this program to display random points and measure angles and distances
between them.

Description:
-----------

Points-cli is a small program that takes a given number of randomly generated 
points in 3-Dimensions and plots them in multiple colors using matplotlib. It
then allows for the measurement of angles and distances between the points. 
The points are restricted within boundaries of a box. The user interacts with
the program through both the command line interface and the matplotlib plot.
From the command line interface the user is taken through elaborative steps
that describe the proper arguments and options. The plot is a 3D scatter plot
with an extra feature that enables the user to hover the mouse over any point
to display the number assigned to that point.

After the plot has been displayed an access to a menu appears on the command
line with three options: Measure distance, Measure angle and Exit.


GETTING STARTED
---------------

Dependencies:
------------
1. Python 3.7.6
2. Numpy 1.18.1
3. Matplotlib 3.1.3
4. tqdm 4.47.0


Installing:
----------
pip install Points-cli


Executing program:
-----------------
Points-cli


Help:
----
To make the program run faster opt for a smaller number of points depending 
on the processing power and memory available at your disposal.

You can always use Ctrl+C to prematurely exit the program. 


Authors:
-------
1. Ridhiwan Ramadhan Mseya


Version History:
---------------
--> Version 0.1.1
	-Downloads needed dependencies.
--> Version 0.1
	-Initial Official Release.


License:
-------
This project is licensed under the name Points-cli
License - see the LICENSE file for details.


Acknowledgments:
---------------
Inspiration from Antoine Marion.