Skip to content

Commit b323fcb

Browse files
john-boyer-phdjohn-boyer-phd
authored
Issue24 update license etc (#31)
Closes #24 * README changes * License update * Some updates to toml file * Change README to wording for both the repo and the PyPI package page * Update classifiers * Use link for license document * Slight license edits * Minor edits, esp. to make license and copyright look more like how it is declared in NetworkX * Though PyPI documents "License :: OSI Approved :: BSD License", it is apparently no longer acceptable to include it.
1 parent a548df5 commit b323fcb

3 files changed

Lines changed: 53 additions & 18 deletions

File tree

‎LICENSE.txt‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
License
22
=======
3-
planarity has a BSD-3-Clause license.
4-
5-
The code in planarity/src is Copyright (c) 1997-2015, John M. Boyer.
6-
See planarity/src/LICENSE.TXT
3+
Planarity (the 'planarity' Python package; the software) is released
4+
under the following BSD-3-Clause license.
75

86
::
97

10-
Copyright (C) 2026
8+
Copyright (C) 2016-2026, Planarity Developers
119
Aric Hagberg <aric.hagberg@gmail.com>
10+
Wanda B. K. Boyer <wbkboyer@gmail.com>
11+
John M. Boyer <john.boyer.phd@gmail.com>
1212
All rights reserved.
1313

14+
Planarity includes the Edge Addition Planarity Suite, which is
15+
Copyright (c) 1997-2025, John M. Boyer.
16+
The BSD-3-Clause license for the Edge Additional Planarity Suite
17+
included in Planarity appears here:
18+
https://github.com/graph-algorithms/planarity/blob/master/planarity/src/LICENSE.TXT
19+
1420
Redistribution and use in source and binary forms, with or without
1521
modification, are permitted provided that the following conditions are
1622
met:
@@ -23,7 +29,7 @@ See planarity/src/LICENSE.TXT
2329
disclaimer in the documentation and/or other materials provided
2430
with the distribution.
2531

26-
* Neither the name of the developers nor the names of its
32+
* Neither the names of the Planarity Developers nor the names of its
2733
contributors may be used to endorse or promote products derived
2834
from this software without specific prior written permission.
2935

‎README.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Planarity
2-
Algorithms for graph planarity testing, forbidden subgraph finding, and planar embeddings.
32

4-
This provides a Ptyhon interface for part of Boyer's (C) planarity algorithms found at <https://github.com/graph-algorithms/edge-addition-planarity-suite>
3+
The [`planarity` repository](https://github.com/graph-algorithms/planarity) provides the source code for the [`planarity` Python package](https://pypi.org/project/planarity/). The `planarity` package was originally developed to provide Python and [NetworkX](https://pypi.org/project/networkx/) developers with a Python API to access planar graph testing, embedding, drawing, and forbidden subgraph isolation algorithms from the [Edge Addition Planarity Suite (EAPS)](https://github.com/graph-algorithms/edge-addition-planarity-suite).
4+
5+
The `planarity` repository has now been transferred to the [Github Graph Algorithms Organization](https://github.com/graph-algorithms). The `planarity` repository and Python package will soon be updated with more planarity-related algorithms from [EAPS](https://github.com/graph-algorithms/edge-addition-planarity-suite) as well as its underlying graph library methods that enable developing a wide range of high-performance graph algorithms and applications.
56

67
## Example
78

@@ -44,9 +45,21 @@ In [10]: print(planarity.ascii(edgelist))
4445
---5----
4546
</pre>
4647

47-
See <https://github.com/hagberg/planarity/tree/master/examples> for more examples.
48-
48+
See [here](https://github.com/graph-algorithms/planarity/tree/master/examples) for more examples.
4949

5050

5151
## License
52-
Distributed with a BSD license; see LICENSE.txt.
52+
53+
Planarity (the 'planarity' Python package; the software) is released
54+
under [this BSD-3-Clause license](https://github.com/graph-algorithms/planarity/blob/master/LICENSE.txt).
55+
56+
Copyright (C) 2016-2026, Planarity Developers<br/>
57+
Aric Hagberg <aric.hagberg@gmail.com><br/>
58+
Wanda B. K. Boyer <wbkboyer@gmail.com><br/>
59+
John M. Boyer <john.boyer.phd@gmail.com><br/>
60+
All rights reserved.<br/>
61+
62+
Planarity includes the Edge Addition Planarity Suite, which is<br/>
63+
Copyright (c) 1997-2025, John M. Boyer.<br/>
64+
The BSD-3-Clause license for the Edge Additional Planarity Suite
65+
included in Planarity appears [here](https://github.com/graph-algorithms/planarity/blob/master/planarity/src/LICENSE.TXT).

‎pyproject.toml‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,30 @@
33
# and https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
44

55
[build-system]
6-
# NOTE: Support for project.license-files and SPDX license expressions
7-
# in project.license (PEP 639) were introduced in setuptools version 77.0.0.
8-
requires = ["setuptools>=80", "cython"]
6+
requires = ["setuptools", "cython"]
97
build-backend = "setuptools.build_meta"
108

119
[project]
1210
name = "planarity"
13-
# NOTE: https://peps.python.org/pep-0621/#drop-maintainers-to-unify-with-authors
14-
# states that we should drop "Maintainers" and preference "Authors"
11+
1512
authors = [
1613
{name = "Aric Hagberg", email = "aric.hagberg@gmail.com"},
17-
{name = "Wanda B. Boyer", email = "wbkboyer@gmail.com"},
14+
{name = "Wanda B. K. Boyer", email = "wbkboyer@gmail.com"},
15+
{name = "John M. Boyer", email = "john.boyer.phd@gmail.com"},
16+
]
17+
18+
# NOTE: Only one of authors and maintainers is required, per
19+
# https://packaging.python.org/en/latest/specifications/pyproject-toml
20+
# However, also having maintainers allows a different first maintainer
21+
# to appear, since only the first entry shows on the package page
22+
23+
maintainers = [
24+
{name = "Wanda B. K. Boyer", email = "wbkboyer@gmail.com"},
1825
{name = "John M. Boyer", email = "john.boyer.phd@gmail.com"},
26+
{name = "Aric Hagberg", email = "aric.hagberg@gmail.com"},
1927
]
2028

21-
description = "Python wrapper for the Edge Addition Planarity Suite Graph Library"
29+
description = "Python Wrapper for the Edge Addition Planarity Suite and Graph Library"
2230
readme = "README.md"
2331
requires-python = ">=3.10"
2432
keywords = [
@@ -36,6 +44,7 @@ classifiers = [
3644
"Development Status :: 5 - Production/Stable",
3745
"Intended Audience :: Developers",
3846
"Intended Audience :: Science/Research",
47+
"Intended Audience :: Education",
3948
"Operating System :: OS Independent",
4049
"Programming Language :: Python :: 3",
4150
"Programming Language :: Python :: 3.10",
@@ -44,10 +53,17 @@ classifiers = [
4453
"Programming Language :: Python :: 3.13",
4554
"Programming Language :: Python :: 3.14",
4655
"Programming Language :: Python :: 3 :: Only",
56+
"Programming Language :: C",
57+
"Topic :: Software Development :: Libraries",
4758
"Topic :: Software Development :: Libraries :: Python Modules",
4859
"Topic :: Scientific/Engineering",
60+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
61+
"Topic :: Scientific/Engineering :: Bio-Informatics",
62+
"Topic :: Scientific/Engineering :: Chemistry",
63+
"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
4964
"Topic :: Scientific/Engineering :: Information Analysis",
5065
"Topic :: Scientific/Engineering :: Mathematics",
66+
"Topic :: Scientific/Engineering :: Physics",
5167
"Topic :: Scientific/Engineering :: Visualization"
5268
]
5369
dynamic = ["version"]

0 commit comments

Comments
 (0)