Metadata-Version: 2.3
Name: archetypal-stubs
Version: 0.1.4
Summary: Eppy type stubs for the archetypal package
Keywords: archetypal,typing,stubs
Author: Samuel Letellier-Duchesne
Author-email: Samuel Letellier-Duchesne <samuelduchesne@me.com>
Classifier: Typing :: Stubs Only
Classifier: Programming Language :: Python :: 3
Requires-Dist: types-eplus2310 ; extra == 'eplus2310'
Requires-Python: >=3.9, <4.0
Provides-Extra: eplus2310
Description-Content-Type: text/markdown

# archetypal-stubs

[![PyPI - archetypal-stubs]()](https://pypi.org/project/types-archetypal/)
[![PyPI - Python Version]()](https://pypi.org/project/types-archetypal/)
[![Docs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&amp;logo=MaterialForMkDocs&amp;logoColor=white)](https://types-archetypal.readthedocs.io/)
[![PyPI - Downloads]()]()

Type annotations for
[archetypal 23.1.0]()
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.

Generated with [mypy_eppy_builder 0.0.1](https://github.com/samuelduchesne/mypy-eppy-builder).

## How to install

### Generate locally (recommended)

You can generate type annotations for `archetypal` package locally with `mypy_eppy_builder`.
Use [uv](https://docs.astral.sh/uv/getting-started/installation/) for build isolation.

1. Run mypy_eppy_builder in your package root directory: `uvx --with 'archetypal==23.1.0' mypy_eppy_builder`

### From PyPI with pip

Install `types_eplus2310` to add type checking for `archetypal` package.

```bash
# install type annotations only for archetypal
python -m pip install types_eplus2310

```

## How to uninstall

```bash
# uninstall archetypal-stubs
python -m pip uninstall -y archetypal-stubs
```

## Usage

### VSCode

- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `archetypal-stubs[latest]` in your environment:

```bash
python -m pip install 'archetypal-stubs[latest]'
```

Both type checking and code completion should now work.
No explicit type annotations required, write your `archetypal` code as usual.
