[DEV-11527] add: backwards compat static typing (#303)

Co-authored-by: Sung96kim <sung96kim@gmail.com>

Author: thearchitector

.dockerignore

@@ -0,0 +1,11 @@
+venv
+dist
+docs
+docsrc
+.hypothesis
+.mypy_cache
+.pytest_cache
+.tox
+build
+readme_docs
+scripts

.gitignore

@@ -26,6 +26,7 @@ pip-log.txt
 .coverage
 .tox
 nosetests.xml
+.mypy_cache
 
 # Translations
 *.mo
@@ -37,6 +38,7 @@ nosetests.xml
 .noseids
 .pytest*
 *.json
+.hypothesis
 
 codeship.aes
 .env
@@ -55,10 +57,11 @@ examples/readme.py
 docsrc/_build
 docs/.doctrees
 setup_tests.sh
+test.csv
 
 .venv
 .vscode/
 
 .DS_Store
 .ipynb_checkpoints/
-*.ipynb
+*.ipynb

.pre-commit-config.yaml

@@ -1,12 +1,19 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.5.0
     hooks:
     -   id: check-yaml
+        exclude: ^docs
     -   id: end-of-file-fixer
+        exclude: ^docs
     -   id: trailing-whitespace
+        exclude: ^docs
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        name: isort (python)
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.11.0
     hooks:
     -   id: black
-        language_version: python3

AUTHORS

@@ -1,2 +1,2 @@
 Chris Lee <chris@indico.io>
-Nicolas Kassis<nic@indico.io>
+Nicolas Kassis<nic@indico.io>

CHANGES.txt

@@ -1 +1 @@
-Oct 16 2019 v2.0.0: Complete change of IndicoIo API through the Indico IPA platform. For IPA Platform API use only.
+Oct 16 2019 v2.0.0: Complete change of IndicoIo API through the Indico IPA platform. For IPA Platform API use only.

CODEOWNERS

@@ -1 +1 @@
-* @IndicoDataSolutions/pr-be-indicodata-ai
+* @IndicoDataSolutions/pr-be-indicodata-ai

README.md

@@ -105,13 +105,20 @@ You will also need the following env variables set for the Exchange integration
 2. Activate the virtual environment
    `source venv/bin/activate`
 3. Install the client
-   `python3 setup.py install`
-4. Install pytest
-   `pip3 install pytest`
+   `pip3 install --editable .[all]`
+4. Install test deps
+   `pip3 install "pytest<8" "requests-mock>=1.8.0" "pytest-asyncio>0.21"`
 5. Run tests
    `pytest -sv --host <indico_host> tests/`
    _ Only run unit tests `pytest -sv --host <indico_host> tests/unit/`
    _ Only run integration tests `pytest -sv --host <indico_host> tests/integration/`
+6. Check typing
+   ```sh
+   pip3 install "mypy==1.8" typing_extensions pandas-stubs types-requests types-pytz types-openpyxl
+   mypy --config-file=pyproject.toml
+   ```
+
+Alternatively, run all the unit tests via `docker compose run --rm tester`
 
 # Contributing
 

README.rst

@@ -19,4 +19,4 @@ From source:
 .. code:: bash
 
     git clone https://github.com/IndicoDataSolutions/indico-client-python.git
-    python setup.py install
+    python setup.py install

docker-compose.yaml

@@ -1,7 +1,16 @@
-version: "3"
-
 services:
   indico-client-build:
     build:
       context: .
-    entrypoint: [ "sleep", "infinity" ]
+    entrypoint: ["sleep", "infinity"]
+
+  tester:
+    build:
+      context: .
+      dockerfile: tox.Dockerfile
+    volumes:
+      - ./:/indico-client
+      - ${INDICO_API_TOKEN_PATH:-$HOME/indico_api_token.txt}:/root/indico_api_token.txt
+    environment:
+      INDICO_HOST: ${INDICO_HOST:-dev-ci.us-east-2.indico-dev.indico.io}
+    command: tox -vvvvp

docsrc/conf.py

@@ -35,7 +35,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
-    "sphinx_markdown_builder"
+    "sphinx_markdown_builder",
 ]
 
 # Add any paths that contain templates here, relative to this directory.