Skip to content

Commit

Permalink
Update README.md (python-graphblas#404)
Browse files Browse the repository at this point in the history
* Update README.md

Adds Python version badges

optional dependencies copied from docs

* Update pyproject.toml

Add Sultan Orazbayev as maintainer
  • Loading branch information
SultanOrazbayev authored Mar 11, 2023
1 parent 673650d commit a0c152c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +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)
[![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/)
Expand Down Expand Up @@ -32,6 +33,15 @@ $ pip install python-graphblas
```
This will also install the [SuiteSparse:GraphBLAS](https://github.com/DrTimothyAldenDavis/GraphBLAS) compiled C library.

### Optional Dependencies

The following are not required by python-graphblas, but may be needed for certain functionality to work.

- `pandas` – required for nicer `__repr__`;
- `matplotlib` – required for basic plotting of graphs;
- `scipy` – used in io module to read/write `scipy.sparse` format;
- `networkx` – used in `io` module to interface with `networkx` graphs.

## Description
Currently works with [SuiteSparse:GraphBLAS](https://github.com/DrTimothyAldenDavis/GraphBLAS), but the goal is to make it work with all implementations of the GraphBLAS spec.

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ authors = [
maintainers = [
{name = "Erik Welch", email = "[email protected]"},
{name = "Jim Kitchen", email = "[email protected]"},
{name = "Sultan Orazbayev", email = "[email protected]"},
]
keywords = [
"graphblas",
Expand Down

0 comments on commit a0c152c

Please sign in to comment.