From 935df7c74f14b095aec506e2ecc815efbe91be5c Mon Sep 17 00:00:00 2001 From: Erik Welch Date: Sat, 15 Apr 2023 13:43:10 -0500 Subject: [PATCH 1/2] Add logo and images to README --- .pre-commit-config.yaml | 5 ++++ MANIFEST.in | 5 ++++ README.md | 13 ++++++++-- docs/_static/img/logo-name-medium.svg | 37 +++++++++++++++++++++++++++ 4 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 docs/_static/img/logo-name-medium.svg diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 13caf89e4..4b00aee30 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,6 +4,11 @@ # To run: `pre-commit run --all-files` # To update: `pre-commit autoupdate` # - &flake8_dependencies below needs updated manually +ci: + # See: https://pre-commit.ci/#configuration + autofix_prs: false + autoupdate_schedule: monthly + skip: [pylint, no-commit-to-branch] fail_fast: true default_language_version: python: python3 diff --git a/MANIFEST.in b/MANIFEST.in index f3f4b04bb..e2ff9c410 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,12 @@ recursive-include graphblas *.py +prune docs +prune scripts include setup.py include README.md include LICENSE include MANIFEST.in include graphblas/graphblas.yaml include graphblas/tests/pickle*.pkl +include docs/_static/img/logo-name-medium.svg +include docs/_static/img/draw-example.png +include docs/_static/img/repr-matrix.png diff --git a/README.md b/README.md index dab91782a..9bce4039b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -# Python-graphblas +![Python-graphblas](docs/_static/img/logo-name-medium.svg) [![conda-forge](https://img.shields.io/conda/vn/conda-forge/python-graphblas.svg)](https://anaconda.org/conda-forge/python-graphblas) [![pypi](https://img.shields.io/pypi/v/python-graphblas.svg)](https://pypi.python.org/pypi/python-graphblas/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-graphblas) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/python-graphblas/python-graphblas/blob/main/LICENSE) +
[![Tests](https://github.com/python-graphblas/python-graphblas/workflows/Tests/badge.svg?branch=main)](https://github.com/python-graphblas/python-graphblas/actions) [![Docs](https://readthedocs.org/projects/python-graphblas/badge/?version=latest)](https://python-graphblas.readthedocs.io/en/latest/) [![Coverage](https://coveralls.io/repos/python-graphblas/python-graphblas/badge.svg?branch=main)](https://coveralls.io/r/python-graphblas/python-graphblas) +
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7328791.svg)](https://doi.org/10.5281/zenodo.7328791) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-graphblas/python-graphblas/HEAD?filepath=notebooks%2FIntro%20to%20GraphBLAS%20%2B%20SSSP%20example.ipynb) [![Discord](https://img.shields.io/badge/Chat-Discord-blue)](https://discord.com/invite/vur45CbwMz) Python library for GraphBLAS: high-performance sparse linear algebra for scalable graph analytics. +For algorithms, see +[`graphblas-algorithms`](https://github.com/python-graphblas/graphblas-algorithms). - **Documentation:** [https://python-graphblas.readthedocs.io/](https://python-graphblas.readthedocs.io/) - **GraphBLAS C API:** [https://graphblas.org/docs/GraphBLAS_API_C_v2.0.0.pdf](https://graphblas.org/docs/GraphBLAS_API_C_v2.0.0.pdf) @@ -22,6 +26,11 @@ Python library for GraphBLAS: high-performance sparse linear algebra for scalabl - **Weekly community call:** [https://github.com/python-graphblas/python-graphblas/issues/247](https://github.com/python-graphblas/python-graphblas/issues/247) - **Chat via Discord:** [https://discord.com/invite/vur45CbwMz](https://discord.com/invite/vur45CbwMz) in the [#graphblas channel](https://discord.com/channels/786703927705862175/1024732940233605190) +

+ Directed graph + Adjacency matrix +

+ ## Install Install the latest version of Python-graphblas via conda: ``` @@ -39,7 +48,7 @@ The following are not required by python-graphblas, but may be needed for certai - `pandas` – required for nicer `__repr__`; - `matplotlib` – required for basic plotting of graphs; -- `scipy` – used in io module to read/write `scipy.sparse` format; +- `scipy` – used in `io` module to read/write `scipy.sparse` format; - `networkx` – used in `io` module to interface with `networkx` graphs; - `fast-matrix-market` - for faster read/write of Matrix Market files with `gb.io.mmread` and `gb.io.mmwrite`. diff --git a/docs/_static/img/logo-name-medium.svg b/docs/_static/img/logo-name-medium.svg new file mode 100644 index 000000000..6dd12c307 --- /dev/null +++ b/docs/_static/img/logo-name-medium.svg @@ -0,0 +1,37 @@ + + + + + + + graphblas + python- + From 72a876c6c8464c08c00cda475f155aadf016aad2 Mon Sep 17 00:00:00 2001 From: Erik Welch Date: Sat, 15 Apr 2023 15:59:48 -0500 Subject: [PATCH 2/2] link to pypi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9bce4039b..23fc3650d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![conda-forge](https://img.shields.io/conda/vn/conda-forge/python-graphblas.svg)](https://anaconda.org/conda-forge/python-graphblas) [![pypi](https://img.shields.io/pypi/v/python-graphblas.svg)](https://pypi.python.org/pypi/python-graphblas/) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-graphblas) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-graphblas)](https://pypi.python.org/pypi/python-graphblas/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/python-graphblas/python-graphblas/blob/main/LICENSE)
[![Tests](https://github.com/python-graphblas/python-graphblas/workflows/Tests/badge.svg?branch=main)](https://github.com/python-graphblas/python-graphblas/actions)