Metadata-Version: 2.4
Name: gmpy2-stubs
Version: 2.2.1.0
Summary: Type stubs for gmpy2
Author-email: David Osipov <personal@david-osipov.vision>
Maintainer-email: David Osipov <personal@david-osipov.vision>
License: MIT
Project-URL: Homepage, https://github.com/DavidOsipov/gmpy2-stubs
Project-URL: Issues, https://github.com/DavidOsipov/gmpy2-stubs/issues
Project-URL: Source, https://github.com/DavidOsipov/gmpy2-stubs
Project-URL: Security Advisories, https://github.com/DavidOsipov/gmpy2-stubs/security/advisories
Project-URL: Security Policy, https://github.com/DavidOsipov/gmpy2-stubs/security/policy
Project-URL: Personal Website, https://david-osipov.vision
Project-URL: LinkedIn, https://www.linkedin.com/in/david-osipov
Project-URL: GitHub Profile, https://github.com/DavidOsipov
Project-URL: ISNI, https://isni.org/isni/000000051802960X
Project-URL: ORCID, https://orcid.org/0009-0005-2713-9242
Project-URL: Telegram, https://telegram.me/david_osipov
Project-URL: Signal, https://signal.me/#eu/d68l1UjrWlGVRzbfkVM1bvQMNqCqiae9GM86P_af8ZK2o5E5YSNKbL4MyM9y-2WH
Classifier: Development Status :: 5 - Production/Stable
Classifier: Typing :: Stubs Only
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Stubs Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# gmpy2-stubs

[![PyPI version](https://badge.fury.io/py/gmpy2-stubs.svg)](https://badge.fury.io/py/gmpy2-stubs)

Type stubs for the [gmpy2](https://pypi.org/project/gmpy2/) library (version 2.2.1).

gmpy2 is a C-coded Python extension module that supports multiple-precision arithmetic.  It provides access to the GMP (GNU Multiple Precision Arithmetic Library), MPFR (Multiple-Precision Floating-Point Reliable Library), and MPC (Multiple-Precision Complex Library) libraries.  gmpy2 itself does *not* include type hints. This package provides them.

## Installation

```bash
pip install gmpy2-stubs
```
or, if you'd like to use a specific version.
```bash
pip install gmpy2-stubs==2.2.1.0
```

## Usage
These stubs are automatically used by mypy and other type checkers when you have both `gmpy2` and `gmpy2-stubs` installed.  You do *not* need to import anything from `gmpy2-stubs` directly.

```python
import gmpy2

# Type hints are available here!
x = gmpy2.mpz(123)
y = gmpy2.sqrt(x)
print(y)

```

## Contributing

Contributions and improvements to these stubs are very welcome!  

## License

These stubs are licensed under the MIT License (see the `LICENSE` file).  gmpy2 itself is licensed under the LGPLv3+ license.

## Author:

David Osipov (personal@david-osipov.vision)
*   ISNI: [0000 0005 1802 960X](https://isni.org/isni/000000051802960X)
*   ORCID: [0009-0005-2713-9242](https://orcid.org/0009-0005-2713-9242)
*   PGP key: https://openpgpkey.david-osipov.vision/.well-known/openpgpkey/david-osipov.vision/D3FC4983E500AC3F7F136EB80E55C4A47454E82E.asc
*   PGP fingerprint: D3FC 4983 E500 AC3F 7F13 6EB8 0E55 C4A4 7454 E82E
*   Website: https://david-osipov.vision
*   LinkedIn: https://www.linkedin.com/in/david-osipov/

## Acknowledgements

Thanks to the gmpy2 developers for creating this powerful library!
