Merge pull request #109 from jGaboardi/general_package_maintenance

[WIP] General package maintenance
pysal · Sep 4, 2018 · 3a9a7e1 · 3a9a7e1
2 parents aa4ca2a + e7f9c18
commit 3a9a7e1
Show file tree

Hide file tree

Showing 9 changed files with 963 additions and 227 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,43 @@
 
-pysal/spaghetti
-===============
+[pysal/spaghetti](https://pysal-spaghetti.readthedocs.io)
+=========================================================
 
 SPAtial GrapHs: nETworks, Topology, & Inference
 ===============================================
 
-[![PyPI version](https://badge.fury.io/py/spaghetti.svg)](https://badge.fury.io/py/spaghetti) [![GitHub tag](https://img.shields.io/github/tag/pysal/spaghetti.svg?maxAge=3600&label=Github)](https://github.com/pysal/spaghetti) [![Build Status](https://travis-ci.org/pysal/spaghetti.svg?branch=master)](https://travis-ci.org/pysal/spaghetti) [![Documentation Status](https://readthedocs.org/projects/pysal-spaghetti/badge/?version=latest)](https://pysal-spaghetti.readthedocs.io/en/latest/?badge=latest) [![Gitter](https://badges.gitter.im/pysal/Spaghetti.svg)](https://gitter.im/pysal/Spaghetti?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
+**Build & Versions**
 
-[![Coverage Status](https://coveralls.io/repos/github/pysal/spaghetti/badge.svg)](https://coveralls.io/github/pysal/spaghetti) [![GitHub issues](https://img.shields.io/github/issues/pysal/spaghetti.svg?maxAge=3600)](https://github.com/pysal/spaghetti/issues) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![DOI](https://zenodo.org/badge/88305306.svg)](https://zenodo.org/badge/latestdoi/88305306)
+[![PyPI version](https://badge.fury.io/py/spaghetti.svg)](https://badge.fury.io/py/spaghetti) [![GitHub tag](https://img.shields.io/github/tag/pysal/spaghetti.svg?maxAge=3600&label=Github)](https://github.com/pysal/spaghetti) [![Build Status](https://travis-ci.org/pysal/spaghetti.svg?branch=master)](https://travis-ci.org/pysal/spaghetti) [![Documentation Status](https://readthedocs.org/projects/pysal-spaghetti/badge/?version=latest)](https://pysal-spaghetti.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://coveralls.io/repos/github/pysal/spaghetti/badge.svg)](https://coveralls.io/github/pysal/spaghetti)
 
 
+**Issues & Pull Requests**
+
+[![GitHub issues open](https://img.shields.io/github/issues/pysal/spaghetti.svg?maxAge=3600)](https://github.com/pysal/spaghetti/issues) [![GitHub issues closed](https://img.shields.io/github/issues-closed/pysal/spaghetti.svg?maxAge=3600)](https://github.com/pysal/spaghetti/issues) ![Github pull requests open](https://img.shields.io/github/issues-pr/pysal/spaghetti.svg) ![Github pull requests closed](https://img.shields.io/github/issues-pr-closed/pysal/spaghetti.svg)
+
+**Commit Activity**
+
+![Github commit activity](https://img.shields.io/github/commit-activity/y/pysal/spaghetti.svg) ![Github commit activity](https://img.shields.io/github/commit-activity/4w/pysal/spaghetti.svg) ![Github commit activity](https://img.shields.io/github/commit-activity/w/pysal/spaghetti.svg) 
+
+
+**Community & GitHub Stats**
+
+![Github contributors](https://img.shields.io/github/contributors/pysal/spaghetti.svg) [![Gitter](https://badges.gitter.im/pysal/Spaghetti.svg)](https://gitter.im/pysal/Spaghetti?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ![Github forks](https://img.shields.io/github/forks/pysal/spaghetti.svg?style=social&label=Forks) ![Github stars](https://img.shields.io/github/stars/pysal/spaghetti.svg?style=social&label=Stars) ![Github watchers](https://img.shields.io/github/watchers/pysal/spaghetti.svg?style=social&label=Watchers)
+
+**Languages**
+
+![Pypi python versions](https://img.shields.io/pypi/pyversions/spaghetti.svg) ![Github languages](https://img.shields.io/github/languages/count/pysal/spaghetti.svg) ![Github top language](https://img.shields.io/github/languages/top/pysal/spaghetti.svg)
+
+
+**Licensing & Citation**
+
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![DOI](https://zenodo.org/badge/88305306.svg)](https://zenodo.org/badge/latestdoi/88305306)
+
+**Misc.**
+
+![Github search hit counter](https://img.shields.io/github/search/pysal/spaghetti/goto.svg) ![Github code size in bytes](https://img.shields.io/github/languages/code-size/pysal/spaghetti.svg) ![Github repo size in bytes](https://img.shields.io/github/repo-size/pysal/spaghetti.svg)
+
+--------------------------------------
 
 This package is part of a [refactoring of PySAL](https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules).
 
@@ -85,3 +112,4 @@ year = {2018}
 }
 ```
 
+
diff --git a/README.rst b/README.rst
@@ -1,9 +1,10 @@
-pysal/spaghetti
-===============
+`pysal/spaghetti <https://pysal-spaghetti.readthedocs.io>`_
+============================================================
 
 SPAtial GrapHs: nETworks, Topology, & Inference
 ===============================================
 
+**Build & Versions**
 
 .. image:: https://badge.fury.io/py/spaghetti.svg
    :target: https://badge.fury.io/py/spaghetti
@@ -13,20 +14,55 @@ SPAtial GrapHs: nETworks, Topology, & Inference
    :target: https://travis-ci.org/pysal/spaghetti
 .. image:: https://readthedocs.org/projects/pysal-spaghetti/badge/?version=latest
    :target: https://pysal-spaghetti.readthedocs.io/en/latest/?badge=latest
-.. image:: https://badges.gitter.im/pysal/Spaghetti.svg
-   :target: https://gitter.im/pysal/Spaghetti?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-
-|
-    
 .. image:: https://coveralls.io/repos/github/pysal/spaghetti/badge.svg
    :target: https://coveralls.io/github/pysal/spaghetti
+
+**Issues & Pull Requests**
+
 .. image:: https://img.shields.io/github/issues/pysal/spaghetti.svg?maxAge=3600
    :target: https://github.com/pysal/spaghetti/issues
+.. image:: https://img.shields.io/github/issues-closed/pysal/spaghetti.svg?maxAge=3600
+   :target: https://github.com/pysal/spaghetti/issues-closed
+.. image:: https://img.shields.io/github/issues-pr/pysal/spaghetti.svg
+   :target: https://github.com/pysal/spaghetti/issues-pr
+.. image:: https://img.shields.io/github/issues-pr-closed/pysal/spaghetti.svg
+   :target: https://github.com/pysal/spaghetti/issues-pr-closed
+
+**Commit Activity**
+
+.. image:: https://img.shields.io/github/commit-activity/y/pysal/spaghetti.svg
+.. image:: https://img.shields.io/github/commit-activity/4w/pysal/spaghetti.svg
+.. image:: https://img.shields.io/github/commit-activity/w/pysal/spaghetti.svg
+
+**Community & GitHub Stats**
+
+.. image:: https://img.shields.io/github/contributors/pysal/spaghetti.svg
+.. image:: https://badges.gitter.im/pysal/Spaghetti.svg
+   :target: https://gitter.im/pysal/Spaghetti?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+.. image:: https://img.shields.io/github/forks/pysal/spaghetti.svg?style=social&label=Forks
+.. image:: https://img.shields.io/github/stars/pysal/spaghetti.svg?style=social&label=Stars
+.. image:: https://img.shields.io/github/watchers/pysal/spaghetti.svg?style=social&label=Watchers
+
+**Languages**
+
+.. image:: https://img.shields.io/pypi/pyversions/spaghetti.svg
+.. image:: https://img.shields.io/github/languages/count/pysal/spaghetti.svg
+.. image:: https://img.shields.io/github/languages/top/pysal/spaghetti.svg
+
+**Licensing & Citation**
+
 .. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
    :target: https://opensource.org/licenses/BSD-3-Clause
 .. image:: https://zenodo.org/badge/88305306.svg
    :target: https://zenodo.org/badge/latestdoi/88305306
 
+**Misc.**
+
+.. image:: https://img.shields.io/github/search/pysal/spaghetti/goto.svg
+.. image:: https://img.shields.io/github/languages/code-size/pysal/spaghetti.svg
+.. image:: https://img.shields.io/github/repo-size/pysal/spaghetti.svg
+
+--------------------------------------
 
 This package is part of a `refactoring of PySAL
 <https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules>`_.
@@ -42,7 +78,7 @@ Examples
 * `Network Usage <https://github.com/pysal/spaghetti/blob/master/notebooks/Network_Usage.ipynb>`_
 * `Spaghetti Pointpatterns Empirical <https://github.com/pysal/spaghetti/blob/master/notebooks/Spaghetti_Pointpatterns_Empirical.ipynb>`_
 * `Snapping Demonstration <https://github.com/pysal/spaghetti/blob/master/notebooks/Snapping_Demonstration.ipynb>`_
-* `Facility Location` <https://github.com/pysal/spaghetti/blob/master/notebooks/Facility_Location.ipynb>`_
+* `Facility Location <https://github.com/pysal/spaghetti/blob/master/notebooks/Facility_Location.ipynb>`_
 
 Installation
 ------------
@@ -95,5 +131,3 @@ BibTeX Citation
     url = {https://github.com/pysal/spaghetti},
     year = {2018}
     }
-
-
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/html/_sources/index.rst.txt b/doc/_build/html/_sources/index.rst.txt
@@ -31,7 +31,7 @@ the analysis of network events.
             <a href="http://nbviewer.jupyter.org/gist/jGaboardi/2697ff11933bb0ea8b94c4326a540453" class="thumbnail">
                 <img src="_static/images/network_k.png" class="img-responsive center-block">
                 <div class="caption text-center">
-                <h6>Network Analysis: Network K Function</h6>
+                <h6>Spaghetti Network Functionality</h6>
                 </div>
             </a>
         </div>

diff --git a/doc/_build/html/index.html b/doc/_build/html/index.html
@@ -148,7 +148,7 @@ <h6>Snapping Points to Segments</h6>
         <a href="http://nbviewer.jupyter.org/gist/jGaboardi/2697ff11933bb0ea8b94c4326a540453" class="thumbnail">
             <img src="_static/images/network_k.png" class="img-responsive center-block">
             <div class="caption text-center">
-            <h6>Network Analysis: Network K Function</h6>
+            <h6>Spaghetti Network Functionality</h6>
             </div>
         </a>
     </div>

diff --git a/doc/index.rst b/doc/index.rst
@@ -31,7 +31,7 @@ the analysis of network events.
             <a href="http://nbviewer.jupyter.org/gist/jGaboardi/2697ff11933bb0ea8b94c4326a540453" class="thumbnail">
                 <img src="_static/images/network_k.png" class="img-responsive center-block">
                 <div class="caption text-center">
-                <h6>Network Analysis: Network K Function</h6>
+                <h6>Spaghetti Network Functionality</h6>
                 </div>
             </a>
         </div>