From 628788723b2d63eb05ba96cb17f755fefd2c45bc Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Tue, 1 Sep 2026 16:07:10 +0200 Subject: [PATCH] docs: restructure README top section to standard ecosystem layout Follows the layout documented in rvc-ecosystem's README.md (tagline, quick links, badges in Status & Project Health / Ecosystem & Dependencies groups) already used by RTB, MVTB, bdsim, and sphinx-pyrunblock. Also fixes two stale details along the way: - The license badge pointed at img.shields.io/github/license/Naereen/StrapDown.js.svg, a static badge for an unrelated repo, not pgraph-python's own MIT license. - The downloads badge used shields.io's pypi/dw endpoint, which the ecosystem doc notes is subject to rate limiting; switched to pepy.tech. Adds powered-by badges for NumPy, SciPy, and Matplotlib -- real dependencies that weren't previously badged, matching the doc's "major packages used" guidance. --- README.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b83c4077..f983cbed 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,36 @@ # PGraph: graphs for Python -[![A Python Robotics Package](https://raw.githubusercontent.com/petercorke/robotics-toolbox-python/main/.github/svg/py_collection.min.svg)](https://github.com/petercorke/robotics-toolbox-python) -[![Powered by Spatial Maths](https://raw.githubusercontent.com/petercorke/spatialmath-python/master/.github/svg/sm_powered.min.svg)](https://github.com/petercorke/spatialmath-python) -[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io) - -[![PyPI version fury.io](https://badge.fury.io/py/pgraph-python.svg)](https://pypi.python.org/pypi/pgraph-python/) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pgraph-python)](https://pypi.python.org/pypi/pgraph-python/) -[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/petercorke/pgraph-python/blob/main/LICENSE) - -[![Build Status](https://github.com/petercorke/pgraph-python/actions/workflows/ci.yml/badge.svg)](https://github.com/petercorke/pgraph-python/actions?query=workflow%3ACI) +
+ Mathematical graphs for Python +

+ +[![PyPI version](https://img.shields.io/pypi/v/pgraph-python?style=for-the-badge&color=blue)](https://pypi.org/project/pgraph-python/) + [![Documentation](https://img.shields.io/badge/Docs-View_Online-blue?style=for-the-badge)](https://petercorke.github.io/pgraph-python) + +

+ GitHub • + Wiki • + Changelog +

+
+ +--- + +### Status & Project Health +[![Build Status](https://github.com/petercorke/pgraph-python/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/petercorke/pgraph-python/actions/workflows/ci.yml) +[![Downloads](https://static.pepy.tech/badge/pgraph-python/month)](https://pepy.tech/projects/pgraph-python) +![Python Version](https://img.shields.io/pypi/pyversions/pgraph-python.svg) [![Coverage](https://codecov.io/gh/petercorke/pgraph-python/branch/main/graph/badge.svg)](https://codecov.io/gh/petercorke/pgraph-python) -![pypi downloads](https://img.shields.io/pypi/dw/pgraph-python) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -- [GitHub repository](https://github.com/petercorke/pgraph-python) -- [Wiki (examples and details)](https://github.com/petercorke/pgraph-python/wiki) -- [Documentation](https://petercorke.github.io/pgraph-python) -- [Changelog](https://github.com/petercorke/pgraph-python/blob/main/CHANGELOG.md) -- Dependencies: [`numpy`](https://numpy.org) [`spatialmath`](https://github.com/bdaiinstitute/spatialmath-python) +### Ecosystem & Dependencies +[![A Python Robotics Package](https://raw.githubusercontent.com/petercorke/robotics-toolbox-python/main/.github/svg/py_collection.min.svg)](https://github.com/petercorke/robotics-toolbox-python) +[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io) +[![powered by NumPy](https://img.shields.io/badge/powered_by-NumPy-013243?logo=numpy&logoColor=white)](https://numpy.org) +[![powered by SciPy](https://img.shields.io/badge/powered_by-SciPy-0054a6?logo=scipy&logoColor=white)](https://scipy.org) +[![powered by Matplotlib](https://img.shields.io/badge/powered_by-Matplotlib-11557c?logo=matplotlib&logoColor=white)](https://matplotlib.org) +[![Powered by Spatial Maths](https://raw.githubusercontent.com/petercorke/spatialmath-python/master/.github/svg/sm_powered.min.svg)](https://github.com/petercorke/spatialmath-python) This Python package allows the manipulation of directed and non-directed graphs. Also supports embedded graphs. It is suitable for graphs with thousands of nodes.