Metadata-Version: 2.1
Name: bigrandomgraphs
Version: 0.1.0
Summary: Python package for fast creation of large random graphs
Author: Jason P. Smith
License: MIT License
         
         Copyright (c) 2024 Jason Smith
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
Requires-Python: >=3.9
Requires-Dist: numpy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Description-Content-Type: text/markdown

# bigrandomgraphs

Fast, parallel generation of large sparse random graphs in C++ with a Python interface.

## Install

```bash
pip install bigrandomgraphs          # from PyPI (once published)
pip install .                        # from a local checkout
pip install git+https://github.com/<user>/bigrandomgraphs.git
```

Python ≥ 3.9. Source installs need a C++ compiler; CMake ≥ 3.15 is fetched automatically by the build frontend if not already present. Pre-built wheels are produced by CI for Linux x86_64, macOS arm64, macOS x86_64, and Windows x64 across CPython 3.9–3.13.

## Testing

```bash
pip install -e .[test]
python -m pytest
```

Use `python -m pytest` rather than bare `pytest` — the latter resolves via `$PATH` and can end up in a Python environment that doesn't have `bigrandomgraphs` installed, producing a confusing `ModuleNotFoundError: No module named 'pybrg'` at collection time.

## TODO

* [ ] Add "Publish to PyPI" in github workflows

## License

See [LICENSE](LICENSE).
