No project description provided
Project description
pdan
In what follows
python
is an alias forpython3.8
or any later version (python3.9
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 pdan
Developer
Download the latest version from GitHub
repository
git clone https://github.com/LostFan123/pdan.git
cd pdan
Install dependencies:
poetry install
Usage
>>> from pdan import minimizing_split, Contour, Point, Polygon
>>> contour = Contour([Point(0, 0), Point(1, 0), Point(1, 1), Point(0, 1)])
>>> part, other = minimizing_split(contour, 0.5, key=lambda x, y: x.length)
>>> assert Polygon(part).area == Polygon(other).area == 0.5
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
.
Notes
To avoid inconsistency between branches and pull requests,
bumping version should be merged into master
branch
as separate pull request.
Running tests
Plain:
pytest
Inside Docker
container:
docker-compose --file docker-compose.cpython.yml up
Bash
script (e.g. can be used in Git
hooks):
./run-tests.sh
or
./run-tests.sh cpython
PowerShell
script (e.g. can be used in Git
hooks):
.\run-tests.ps1
or
.\run-tests.ps1 cpython
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.