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.

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

Manage dev-dependencies better. #465

Open
7 tasks
huxuan opened this issue Apr 11, 2024 · 1 comment
Open
7 tasks

Manage dev-dependencies better. #465

huxuan opened this issue Apr 11, 2024 · 1 comment
Labels
dependencies Dependency related
Milestone

Comments

@huxuan
Copy link
Member

huxuan commented Apr 11, 2024

As discussed in #460

A brief summarization

  1. Standalone tools managed by pipx
    • copier
    • pdm
    • pre-commit
    • toml-sort
    • ruff
    • codespell
    • check-jsonschema
  2. Semi-dependent tools included in dev-dependencies but locked with a different lock file
    • mypy (needs installation of prod dependencies for type checking)
    • sphinx and the whole doc group (needs installation of the project to extract version)
  3. Fully dependent tools included in dev-dependencies and locked with the main pdm.lock
    • pytest and the whole test group

Task list

  • Docs update for install standalone tools with pipx
  • Separated lock files for sphinx and mypy
  • pdm related pre-commit hooks
  • Makefile
  • CI/CD
  • Docs for Development Environment
  • Add codespell
@huxuan huxuan added the enhancement New feature or request label Apr 24, 2024
@huxuan huxuan added this to the v0.1.0 milestone Apr 24, 2024
@huxuan huxuan added dependencies Dependency related and removed enhancement New feature or request labels Apr 24, 2024
@huxuan
Copy link
Member Author

huxuan commented Jul 6, 2024

I suddenly realize that the doc group is a superset of lint and test group since we need mypy and coverage report when generating documentation. So it seems that we only need two lockfiles, one is the default pdm.lock but only for production (pdm lock --prod), and the other is for dev which can be named as pdm.dev.lock (pdm lock --no-default --lockfile pdm.dev.lock). WDYT? @msclock

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Dependency related
Projects
None yet
Development

No branches or pull requests

1 participant