Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md: Update Development section with Nox and Nix commands #48

Merged
merged 2 commits into from
Jan 12, 2023
Merged

README.md: Update Development section with Nox and Nix commands #48

merged 2 commits into from
Jan 12, 2023

Commits on Jan 12, 2023

  1. README.md: Update Development section with Nox and Nix commands 

    Rewrite the Development section completely, to document how we (in
addition to Poetry) use Nox for test/workflow automation.

Also add a small, final section presenting the Nix way.
    @jherland
    jherland committed Jan 12, 2023
    Configuration menu
    Copy the full SHA
    2803d12 View commit details
    Browse the repository at this point in the history

  2. noxfile.py: Run mypy without arguments to type-check top-level scripts 

    We already have appropriate directives in our pyproject.toml to control
Mypy's execution. The command-line args are unnecessary.

However, as a consequence, when we run `mypy` inside the `lint-3.*`
session in Nox, we will now _also_ perform type-checking on any Python
scripts in our top-level directory. This includes the `noxfile.py`
itself, which (since it contains an `import nox` statement) means that
Nox must also be availale in the environment when Mypy is run. Thus we
need to add Nox to the `lint` dependency group.
    @jherland
    jherland committed Jan 12, 2023
    Configuration menu
    Copy the full SHA
    c7390f8 View commit details
    Browse the repository at this point in the history