Merge pull request #32 from graph-algorithms/Issue28-PublishToTestPyPI

Resolves #28 - Changes required to install `planarity` from Source Distribution published to TestPyPI

Author: wbkboyer

LICENSE.txt

@@ -5,7 +5,7 @@ under the following BSD-3-Clause license.
 
 ::
 
-   Copyright (C) 2016-2026, Planarity Developers
+   Copyright (c) 2016-2026, Planarity Developers
    Aric Hagberg <aric.hagberg@gmail.com>
    Wanda B. K. Boyer <wbkboyer@gmail.com>
    John M. Boyer <john.boyer.phd@gmail.com>

MANIFEST.in

@@ -1,14 +1,15 @@
 include MANIFEST.in
 include setup.py
-include INSTALL.txt
+
 include LICENSE.txt
+include planarity/c/LICENSE.TXT
+
 include README.md
+include planarity/c/README
 
 include planarity/cplanarity.pxd
 include planarity/planarity.c
 include planarity/planarity.pyx
-include planarity/src/*.c
-include planarity/src/*.h
 
 recursive-include examples *.py *.gz
 recursive-include doc *.py *.rst Makefile *.html *.txt

README.md

@@ -45,15 +45,21 @@ In [10]: print(planarity.ascii(edgelist))
  ---5----
 </pre>
 
-See [here](https://github.com/graph-algorithms/planarity/tree/master/examples) for more examples.
+```python
+In [11]: # Shows correspondence between vertex labels and indices
 
+In [12]: print(planarity.mapping(edgelist))
+{1: 'd', 2: 'c', 3: 'e', 4: 'a', 5: 'b'}
+```
+
+See [here](https://github.com/graph-algorithms/planarity/tree/master/examples) for more examples.
 
 ## License
 
 Planarity (the 'planarity' Python package; the software) is released
 under [this BSD-3-Clause license](https://github.com/graph-algorithms/planarity/blob/master/LICENSE.txt).
 
-   Copyright (C) 2016-2026, Planarity Developers<br/>
+   Copyright (c) 2016-2026, Planarity Developers<br/>
    Aric Hagberg <aric.hagberg@gmail.com><br/>
    Wanda B. K. Boyer <wbkboyer@gmail.com><br/>
    John M. Boyer <john.boyer.phd@gmail.com><br/>
@@ -62,4 +68,4 @@ under [this BSD-3-Clause license](https://github.com/graph-algorithms/planarity/
    Planarity includes the Edge Addition Planarity Suite, which is<br/> 
    Copyright (c) 1997-2025, John M. Boyer.<br/>
    The BSD-3-Clause license for the Edge Additional Planarity Suite
-   included in Planarity appears [here](https://github.com/graph-algorithms/planarity/blob/master/planarity/src/LICENSE.TXT).
+   included in Planarity appears [here](https://github.com/graph-algorithms/planarity/blob/master/planarity/c/LICENSE.TXT).

planarity/__init__.py

@@ -4,4 +4,4 @@
 
 # NOTE: In the future, we could automatically generate the version number by
 # configuring setuptools-scm, but presently this seems simpler.
-__version__ = "0.7.0"
+__version__ = "0.7.8"

planarity/src/LICENSE.TXT planarity/c/LICENSE.TXTplanarity/src/LICENSE.TXT renamed to planarity/c/LICENSE.TXT

@@ -1,46 +1,48 @@
-The Edge Addition Planarity Suite
-Copyright (c) 1997-2015, John M. Boyer
-All rights reserved. Includes a reference implementation of the following:
-
-* John M. Boyer. "Subgraph Homeomorphism via the Edge Addition Planarity Algorithm".
-  Journal of Graph Algorithms and Applications, Vol. 16, no. 2, pp. 381-410, 2012.
-  http://www.jgaa.info/16/268.html
-
-* John M. Boyer. "A New Method for Efficiently Generating Planar Graph
-  Visibility Representations". In P. Eades and P. Healy, editors,
-  Proceedings of the 13th International Conference on Graph Drawing 2005,
-  Lecture Notes Comput. Sci., Volume 3843, pp. 508-511, Springer-Verlag, 2006.
-
-* John M. Boyer and Wendy J. Myrvold. "On the Cutting Edge: Simplified O(n)
-  Planarity by Edge Addition". Journal of Graph Algorithms and Applications,
-  Vol. 8, No. 3, pp. 241-273, 2004.
-  http://www.jgaa.info/08/91.html
-
-* John M. Boyer. "Simplified O(n) Algorithms for Planar Graph Embedding,
-  Kuratowski Subgraph Isolation, and Related Problems". Ph.D. Dissertation,
-  University of Victoria, 2001.
-
-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.
-
-* Neither the name of The Edge Addition Planarity Suite nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-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 HOLDER 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.
+The Edge Addition Planarity Suite
+Copyright (c) 1997-2025, John M. Boyer
+All rights reserved. Includes a reference implementation of the following:
+
+* John M. Boyer. "Subgraph Homeomorphism via the Edge Addition Planarity Algorithm".
+  Journal of Graph Algorithms and Applications, Vol. 16, no. 2, pp. 381-410, 2012.
+  http://dx.doi.org/10.7155/jgaa.00268
+
+* John M. Boyer. "A New Method for Efficiently Generating Planar Graph
+  Visibility Representations". In P. Eades and P. Healy, editors,
+  Proceedings of the 13th International Conference on Graph Drawing 2005,
+  Lecture Notes Comput. Sci., Volume 3843, pp. 508-511, Springer-Verlag, 2006.
+  http://dx.doi.org/10.1007/11618058_47
+
+* John M. Boyer and Wendy J. Myrvold. "On the Cutting Edge: Simplified O(n)
+  Planarity by Edge Addition". Journal of Graph Algorithms and Applications,
+  Vol. 8, No. 3, pp. 241-273, 2004.
+  http://dx.doi.org/10.7155/jgaa.00091
+
+* John M. Boyer. "Simplified O(n) Algorithms for Planar Graph Embedding,
+  Kuratowski Subgraph Isolation, and Related Problems". Ph.D. Dissertation,
+  University of Victoria, 2001.
+  https://dspace.library.uvic.ca/handle/1828/9918
+
+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.
+
+* Neither the name of The Edge Addition Planarity Suite nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+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 HOLDER 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.