Update pyproject.toml to reflect requirements.txt

KULeuven-MICAS / zigzag

HW Architecture-Mapping Design Space Exploration Framework for Deep Learning Accelerators

https://kuleuven-micas.github.io/zigzag/

MIT License

104 stars 36 forks source link

Update pyproject.toml to reflect requirements.txt #56

Closed Andful closed 4 months ago

RobinGeens commented 4 months ago

I'm not sure whether typeguard and pytest should be part of the project dependencies since they are only used for testing? I don't think the tests are shipped together with the project

asyms commented 4 months ago

Robin is correct. We need those packages to be put in the optional 'dev' part (https://peps.python.org/pep-0508/#extras). The project can then be installed including these packages using:

pip install zigzag-dse[dev]

Andful commented 4 months ago

I will update the pull request!

asyms commented 4 months ago

Great! Could you also update the documentation to reflect this? That would be this part:

https://github.com/KULeuven-MICAS/zigzag/blob/master/docs/source/contribute.rst#upgrading-the-project-version-for-zigzag-developers

Andful commented 4 months ago

Updated the documentation.
I added ruff both to pyproject.toml and requiriments.txt.
In the linting workflow, I removed installing from requiriments.txt, pip install .[dev] is enough.