Page MenuHomeSoftware Heritage

Add requirements-dev.txt
AbandonedPublic

Authored by acezar on Jul 16 2020, 10:35 AM.

Details

Reviewers
None
Group Reviewers
Reviewers
Summary

There was a missing way to install all the required dependendies for
development in one pass. I also added development specific tools to
check and format code.

Diff Detail

Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 13652
Build 20915: arc lint + arc unit

Event Timeline

Thanks. Yes, we don't have that because we have many repositories (and quite a lot of setup-ish files: mypy.ini, pytest.ini, tox.ini, requirements*...) already.

Although, we are referencing how to install deps in our getting-started [1].
But granted, there might be much to read prior to reach that part...

[1] https://docs.softwareheritage.org/devel/developer-setup.html#checkout-the-source-code

same here, that needs to happen on all our repositories if we ever go that way

ping @anlambert @olasd @douardda ^

I'm not very fond of yet another requirement file.

pre-commit and mypy should be installed from the swh-environment setup, black is not strictly necessary since it's executed from pre-commit (thus from a dedicated venv), and I believe isort should be handled the same.

Documentation on swh-environment could be improved however, and should be referenced from the README file of this (and any other swh) repo.