Package: parts
Minimal library that enables partitioning of iterable objects in a concise manner.PurposeThis library provides a function for partitioningiterabledata structure instances. When the number of parts is specified explicitly, it is treated as a strict requirement and an exception is raised when it cannot be satisfied. When a length for all parts (or each part) is specified explicitly, a best-effort approach is used: as many parts of the specified length are retrieved as possible, with the possibility that some parts at the end of the partition sequence have a shorter (but still non-zero) length.Installation and UsageThis library is available as apackage on PyPI:python-mpipinstallpartsThe library can be imported in the usual manner:importpartsfrompartsimportpartsExamplesSeveral examples are presented below:>>>list(parts([1,2,3,4,5,6,7],length=2))[[1,2],[3,4],[5,6],[7]]>>>list(parts([1,2,3,4,5,6,7],length=4))[[1,2,3,4],[5,6,7]]>>>list(parts([1,2,3,4,5,6,7],number=1))[[1,2,3,4,5,6,7]]>>>list(parts([1,2,3,4,5,6,7],5))[[1],[2],[3],[4,5],[6,7]]>>>list(parts([1,2,3,4,5,6],2,3))[[1,2,3],[4,5,6]]>>>list(parts([1,2,3,4,5,6],number=3,length=2))[[1,2],[3,4],[5,6]]>>>list(parts([1,2,3,4,5,6,7],7,[1,1,1,1,1,1,1]))[[1],[2],[3],[4],[5],[6],[7]]>>>list(parts([1,2,3,4,5,6],length=[2,2,2]))[[1,2],[3,4],[5,6]]>>>list(parts([1,2,3,4,5,6],length=[1,2,3]))[[1],[2,3],[4,5,6]]>>>list(parts([1,2,3,4,5,6,7],number=3,length=2))Traceback(mostrecentcalllast):...ValueError:cannotretrieve3partsfromobjectgivenpartlengthparameterof2DevelopmentAll installation and development dependencies are fully specified inpyproject.toml. Theproject.optional-dependenciesobject is used tospecify optional requirementsfor various development tasks. This makes it possible to specify additional options (such asdocs,lint, and so on) when performing installation usingpip:python-mpipinstall.[docs,lint]DocumentationThe documentation can be generated automatically from the source files usingSphinx:python-mpipinstall.[docs]cddocssphinx-apidoc-f-E--templatedir=_templates-o_source..&&makehtmlTesting and ConventionsAll unit tests are executed and their coverage is measured when usingpytest(see thepyproject.tomlfile for configuration details):python-mpipinstall.[test]python-mpytestAlternatively, all unit tests are included in the module itself and can be executed usingdoctest:pythonsrc/parts/parts.py-vStyle conventions are enforced usingPylint:python-mpipinstall.[lint]python-mpylintsrc/partsContributionsIn order to contribute to the source code, open an issue or submit a pull request on theGitHub pagefor this library.VersioningBeginning with version 0.2.0, the version number format for this library and the changes to the library associated with version number increments conform withSemantic Versioning 2.0.0.PublishingThis library can be published as apackage on PyPIby a package maintainer. First, install the dependencies required for packaging and publishing:python-mpipinstall.[publish]Ensure that the correct version number appears inpyproject.toml, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has anautomation rulethat activates and sets as the default all tagged versions. Create and push a tag for this version (replacing?.?.?with the version number):gittag?.?.?gitpushorigin?.?.?Remove any old build/distribution files. Then, package the source into a distribution archive:rm-rfbuilddistsrc/*.egg-infopython-mbuild--sdist--wheel.Finally, upload the package distribution archive toPyPI:python-mtwineuploaddist/*