Metadata-Version: 2.1
Name: scipy-stubs
Version: 1.4.1a1
Summary: 
Home-page: https://github.com/jorenham/scipy-stubs/
License: BSD-3-Clause
Author: Joren Hammudoglu
Author-email: jhammudoglu@gmail.com
Requires-Python: >=3.10.1,<4.0.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Stubs Only
Classifier: Typing :: Typed
Requires-Dist: optype (>=0.6.1,<0.7.0)
Requires-Dist: scipy (>=1.14.1,<2.0.0)
Project-URL: Bug Tracker, https://github.com/jorenham/scipy-stubs/issues
Project-URL: Changelog, https://github.com/jorenham/scipy-stubs/releases
Project-URL: Documentation, https://github.com/jorenham/scipy-stubs?tab=readme-ov-file#scipy-stubs
Project-URL: Repository, https://github.com/jorenham/scipy-stubs/
Description-Content-Type: text/markdown

<h1 align="center">scipy-stubs</h1>

<p align="center">
    Building blocks for precise & flexible type hints.
</p>

<p align="center">
    <a href="https://pypi.org/project/scipy-stubs/">
        <img
            alt="scipy-stubs - PyPI"
            src="https://img.shields.io/pypi/v/scipy-stubs?style=flat&color=olive"
        />
    </a>
    <a href="https://github.com/jorenham/scipy-stubs">
        <img
            alt="scipy-stubs - Python Versions"
            src="https://img.shields.io/pypi/pyversions/scipy-stubs?style=flat"
        />
    </a>
    <a href="https://github.com/jorenham/scipy-stubs">
        <img
            alt="scipy-stubs - dependencies"
            src="https://img.shields.io/librariesio/github/jorenham/scipy-stubs?style=flat&color=violet"
        />
    </a>
    <a href="https://github.com/jorenham/scipy-stubs">
        <img
            alt="scipy-stubs - license"
            src="https://img.shields.io/github/license/jorenham/scipy-stubs?style=flat"
        />
    </a>
</p>
<p align="center">
    <a href="https://github.com/jorenham/scipy-stubs/actions?query=workflow%3ACI">
        <img
            alt="scipy-stubs - CI"
            src="https://github.com/jorenham/scipy-stubs/workflows/CI/badge.svg"
        />
    </a>
    <!-- TODO -->
    <!-- <a href="https://github.com/pre-commit/pre-commit">
        <img
            alt="scipy-stubs - pre-commit"
            src="https://img.shields.io/badge/pre--commit-enabled-teal?logo=pre-commit"
        />
    </a> -->
    <a href="https://github.com/KotlinIsland/basedmypy">
        <img
            alt="scipy-stubs - basedmypy"
            src="https://img.shields.io/badge/basedmypy-checked-fd9002"
        />
    </a>
    <a href="https://detachhead.github.io/basedpyright">
        <img
            alt="scipy-stubs - basedpyright"
            src="https://img.shields.io/badge/basedpyright-checked-42b983"
        />
    </a>
    <a href="https://github.com/astral-sh/ruff">
        <img
            alt="scipy-stubs - ruff"
            src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"
        />
    </a>
</p>

---

## Installation

The `scipy-stubs` package is available as on PyPI:

```shell
pip install scipy-stubs
```

> [!IMPORTANT]
> This project is in the early development stage, and is not ready for production use.

## Development Progress

According to [basedpyright](https://github.com/DetachHead/basedpyright) (stricter than
pyright), the "type completeness score" is **38.6%**
[at the time of writing](https://github.com/jorenham/scipy-stubs/tree/15f8b2c).

| Module                            | Stubs status    |
|---------------------------------- |---------------- |
| `scipy`                           | 1: skeleton     |
| `scipy._lib`                      | 2: partial      |
| `scipy._lib.uarray`               | 3: ready        |
| `scipy._lib.array_api_compat`     | 2: partial      |
| `scipy.cluster`                   | 1: skeleton     |
| `scipy.constants`                 | 3: ready        |
| `scipy.datasets`                  | 2: partial      |
| `scipy.fft`                       | 2: partial      |
| `scipy.fft._pocketfft`            | 2: partial      |
| `scipy.fftpack`                   | 2: partial      |
| `scipy.integrate`                 | 2: partial      |
| `scipy.integrate._ivp`            | 2: partial      |
| `scipy.interpolate`               | 2: partial      |
| `scipy.io`                        | 2: partial      |
| `scipy.io.arff`                   | 2: partial      |
| `scipy.io.matlab`                 | 2: partial      |
| `scipy.linalg`                    | 3: ready        |
| `scipy.misc`                      | 0: missing      |
| `scipy.ndimage`                   | 2: partial      |
| `scipy.odr`                       | 1: skeleton     |
| `scipy.optimize`                  | 2: partial      |
| `scipy.optimize.cython_optimize`  | 0: missing      |
| `scipy.optimize.zeros`            | 0: missing      |
| `scipy.signal`                    | 2: partial      |
| `scipy.signal.windows`            | 1: skeleton     |
| `scipy.sparse`                    | 2: partial      |
| `scipy.sparse.csgraph`            | 2: partial      |
| `scipy.sparse.linalg`             | 2: partial      |
| `scipy.spatial`                   | 2: partial      |
| `scipy.spatial.distance`          | 3: ready        |
| `scipy.special`                   | 3: ready        |
| `scipy.special.cython_special`    | 2: partial      |
| `scipy.stats`                     | 2: partial      |
| `scipy.stats.contingency`         | 1: skeleton     |
| `scipy.stats.distributions`       | 3: ready        |
| `scipy.stats.mstats`              | 1: skeleton     |
| `scipy.stats.qmc`                 | 2: partial      |
| `scipy.stats.sampling`            | 1: skeleton     |

Status labels:

0. missing (failed stubgen)
1. skeleton (mostly succesful stubgen)
2. partial (incomplete/broad annotations)
3. ready (complete & valid annotations, untested)
4. done (complete, valid, tested, and production-ready)

