GitLocker: The Coding Marketplace

Description:

ground 9.0.0

ground

Summary
ground is a pure Python library that provides protocols
for planar computational geometry models & operations
to unify interaction between different libraries
and allow customization.

In what follows python is an alias for python3.7 or pypy3.7
or any later version (python3.8, pypy3.8 and so on).
Installation
Install the latest pip & setuptools packages versions
python -m pip install --upgrade pip setuptools

User
Download and install the latest stable version from PyPI repository
python -m pip install --upgrade ground

Developer
Download the latest version from GitHub repository
git clone https://github.com/lycantropos/ground.git
cd ground

Install dependencies
python -m pip install -r requirements.txt

Install
python setup.py install

Usage
>>> from ground.base import get_context
>>> context = get_context()
>>> Multipoint = context.multipoint_cls
>>> Point = context.point_cls
>>> Segment = context.segment_cls
>>> origin = Point(0, 0)
>>> x_unit = Point(1, 0)
>>> y_unit = Point(0, 1)
>>> from ground.base import Kind
>>> context.angle_kind(origin, x_unit, y_unit) is Kind.RIGHT
True
>>> from ground.base import Orientation
>>> (context.angle_orientation(origin, x_unit, y_unit)
... is Orientation.COUNTERCLOCKWISE)
True
>>> context.cross_product(origin, x_unit, origin, y_unit) == 1
True
>>> context.dot_product(origin, x_unit, origin, y_unit) == 0
True
>>> context.multipoint_centroid(Multipoint([origin])) == origin
True
>>> (context.points_convex_hull([origin, x_unit, y_unit])
... == [origin, x_unit, y_unit])
True
>>> context.segment_contains_point(Segment(origin, x_unit), y_unit)
False
>>> context.segment_contains_point(Segment(origin, x_unit), origin)
True
>>> context.segments_intersection(Segment(origin, x_unit),
... Segment(origin, y_unit)) == origin
True
>>> from ground.base import Relation
>>> context.segments_relation(Segment(origin, x_unit),
... Segment(origin, y_unit)) is Relation.TOUCH
True

Development
Bumping version
Preparation
Install
bump2version.
Pre-release
Choose which version number category to bump following semver
specification.
Test bumping version
bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible
values are patch/minor/major.
Bump version
bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.
Release
Test bumping version
bump2version --dry-run --verbose release

Bump version
bump2version --verbose release

This will set version to major.minor.patch.
Running tests
Install dependencies
python -m pip install -r requirements-tests.txt

Plain
pytest

Inside Docker container:

with CPython
docker-compose --file docker-compose.cpython.yml up

with PyPy
docker-compose --file docker-compose.pypy.yml up

Bash script:

with CPython
./run-tests.sh

or
./run-tests.sh cpython

with PyPy
./run-tests.sh pypy

PowerShell script:

with CPython
.\run-tests.ps1

or
.\run-tests.ps1 cpython

with PyPy
.\run-tests.ps1 pypy