=========
PointPare
=========
A simple package for paring together points.
Usage
=====
::
from pointpare import PointPare
pp = PointPare()
pp.add_points([... list of point ...])
pp.pare_points()
pared_points = pp.get_pared_points()
Points can be provided as a list of lists, like so::
points = [[-10.4498, 31.1871, 1161.39], [-9.26793, 26.6263, 1162.51], [-8.96271, 27.5622, 1161.49], [-10.4498, 31.1871, 1161.39]]
pp.add_points(points)
or as a flat list, where the list is divisible by three, like so::
points = [31.1871, 1161.39, -10.7776, 29.8503, 1162.7, -9.26793, 26.6263, 1162.51, -10.7776]
pp.add_points(points)
Testing
=======
Tests are written with unittest and can be run like so::
python -m unittest discover -s tests
Where the working directory is the base directory of the repository.
To run the coverage analysis with::
coverage run --source=src/ -m unittest discover -s tests
Where the working directory is the base directory of the repository.
The report should show something like the following::
Name Stmts Miss Cover
-----------------------------------------------
src/pointpare/__init__.py 54 0 100%
-----------------------------------------------
TOTAL 54 0 100%
from the coverage report command::
coverage report
Raw data
{
"_id": null,
"home_page": "https://github.com/hsorby/pointpare",
"name": "pointpare",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Hugh Sorby",
"author_email": "h.sorby@auckland.ac.nz",
"download_url": "",
"platform": "any",
"description": "\n=========\nPointPare\n=========\n\nA simple package for paring together points.\n\nUsage\n=====\n\n::\n\n from pointpare import PointPare\n pp = PointPare()\n pp.add_points([... list of point ...])\n pp.pare_points()\n pared_points = pp.get_pared_points()\n\nPoints can be provided as a list of lists, like so::\n\n points = [[-10.4498, 31.1871, 1161.39], [-9.26793, 26.6263, 1162.51], [-8.96271, 27.5622, 1161.49], [-10.4498, 31.1871, 1161.39]]\n pp.add_points(points)\n\nor as a flat list, where the list is divisible by three, like so::\n\n points = [31.1871, 1161.39, -10.7776, 29.8503, 1162.7, -9.26793, 26.6263, 1162.51, -10.7776]\n pp.add_points(points)\n\nTesting\n=======\n\nTests are written with unittest and can be run like so::\n\n python -m unittest discover -s tests\n\nWhere the working directory is the base directory of the repository.\n\nTo run the coverage analysis with::\n\n coverage run --source=src/ -m unittest discover -s tests\n\nWhere the working directory is the base directory of the repository.\n\nThe report should show something like the following::\n\n Name Stmts Miss Cover\n -----------------------------------------------\n src/pointpare/__init__.py 54 0 100%\n -----------------------------------------------\n TOTAL 54 0 100%\n\nfrom the coverage report command::\n\n coverage report\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "A simple package for paring together points.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/hsorby/pointpare"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5377c0d0b18611ccfd4386fc4deb6cb731c8d268f467678c9b325510c47ac44d",
"md5": "6a01e5059493ab0eece3312b19c8eb21",
"sha256": "3400d7201c6b293732a79f214d7d6c6d7be415954e5de3924aaaffbde2128f4c"
},
"downloads": -1,
"filename": "pointpare-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a01e5059493ab0eece3312b19c8eb21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6490,
"upload_time": "2023-09-08T01:39:30",
"upload_time_iso_8601": "2023-09-08T01:39:30.030763Z",
"url": "https://files.pythonhosted.org/packages/53/77/c0d0b18611ccfd4386fc4deb6cb731c8d268f467678c9b325510c47ac44d/pointpare-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 01:39:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hsorby",
"github_project": "pointpare",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pointpare"
}
JSON
