cookiecutter / cookiecutter-django

Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.
https://cookiecutter-django.readthedocs.io
BSD 3-Clause "New" or "Revised" License
12.04k stars 2.88k forks source link

[feature request] Add run configuration for mypy #2858

Open AgarwalPragy opened 4 years ago

AgarwalPragy commented 4 years ago

Description

The readme nicely demonstrates how to run the type checks: mypy {{ cookiecutter.project_slug }}

However, this doesn't work when working with docker. For pycharm user, the following run configuration will be helpful

<component name="ProjectRunConfigurationManager">
  <configuration default="false" name="mypy" type="PythonConfigurationType" factoryName="Python">
    <module name="{{ cookiecutter.project_slug }}" />
    <option name="INTERPRETER_OPTIONS" value="" />
    <option name="PARENT_ENVS" value="true" />
    <envs>
      <env name="PYTHONUNBUFFERED" value="1" />
    </envs>
    <option name="SDK_HOME" value="docker-compose://[$PROJECT_DIR$/local.yml]:django/python" />
    <option name="WORKING_DIRECTORY" value="" />
    <option name="IS_MODULE_SDK" value="false" />
    <option name="ADD_CONTENT_ROOTS" value="true" />
    <option name="ADD_SOURCE_ROOTS" value="true" />
    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
    <option name="SCRIPT_NAME" value="mypy" />
    <option name="PARAMETERS" value="{{ cookiecutter.project_slug }}" />
    <option name="SHOW_COMMAND_LINE" value="false" />
    <option name="EMULATE_TERMINAL" value="false" />
    <option name="MODULE_MODE" value="true" />
    <option name="REDIRECT_INPUT" value="false" />
    <option name="INPUT_FILE" value="" />
    <method v="2" />
  </configuration>
</component>
Andrew-Chen-Wang commented 4 years ago

Err for docker-compose, are't you just prepending docker-compose -f local.yml run django mypy?