Installing

From pypi

The project is available on pypi, to install the letest version, do:

$ pip install types-linq -U

From GitHub Repo

Clone the project and install from local files:

$ git clone https://github.com/cleoold/types-linq && cd types-linq
$ pip install .
# or
$ python setup.py install

Run Tests

In the project root, execute the following commands (or something similar) to run the test cases:

# optionally set up venv
$ python -m venv
$ ./scripts/activate

$ pip install pytest
$ python -m pytest

If you want to run the project against pyright, the following should do:

$ npm install pyright -g
$ npx pyright

Instead, opening vscode should also highlight red striggles (?)

However, the GitHub action settings are most up-to-date and can be consulted.

Build the Documentation

To generate the pages you are currently looking at, in the project root, execute the following commands:

$ cd doc
$ pip install -r requirements.txt
# generate api md files
$ python ./gen_api_doc.py
# create html pages, contents are available in _build/html folder
$ make html

Note to generate api files, one must have Python version 3.9 or above. The api md files are committed to the repository.