Commit e7dfbb6f authored by Christoph Groth's avatar Christoph Groth
Browse files

Reorganize package according to current fashion and add boilerplate

parent 726e6544
__pycache__
__pycache__/
*~
.tox/
/build/
/dist/
*.egg-info/
================
Iterpoly license
================
Copyright 2021 Christoph Groth (CEA). All rights reserved.
(CEA = Commissariat à l'énergie atomique et aux énergies alternatives)
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Iterpoly
========
Iterpoly can perform some simple algebra on polynomials that are
represented as Python iterables. However, its main purpose is serving
as an example of packaging a (numerical) Python library.
Usage example
-------------
::
>>> import iterpoly as ip
>>> print(list(ip.diff([2, 1, 0, 4])))
[1, 0, 12]
>>> print(list(ip.diff([2, 7, 0, 4])))
[7, 0, 12]
>>> print(list(ip.integrate([7, 0, 12])))
[0, 7.0, 0.0, 4.0]
[build-system]
requires = [
"setuptools>=42",
"wheel"
]
build-backend = "setuptools.build_meta"
[metadata]
name = iterpoly
version = 0.0.1
author = Christoph Groth
author_email = christoph.groth@cea.fr
description = Algebra on polynomials represented as iterables.
long_description = file: README.rst
url = https://gitlab.kwant-project.org/cwg/iterpoly
project_urls =
Bug Tracker = https://gitlab.kwant-project.org/cwg/iterpoly/-/issues
classifiers =
Programming Language :: Python :: 3
Intended Audience :: Science/Research
License :: OSI Approved :: BSD License
Operating System :: OS Independent
[options]
package_dir =
= src
packages = find:
[options.packages.find]
where = src
[tox]
envlist = ALL
isolated_build = True
[testenv]
deps = pytest # PYPI package providing pytest
commands = pytest {posargs} # substitute with tox' positional arguments
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment