cookiecutter-cms icon indicating copy to clipboard operation
cookiecutter-cms copied to clipboard

Manage testing with tox

Open 4383 opened this issue 5 years ago • 4 comments

These changes aim to manage tests by using tox.

tox provide a command line driven CI frontend and development task automation tool.

The benefits to us tox are:

  • manage several task automatically (see the examples list below)
  • run tests and tasks in dedicated and isolated virtual environments
  • standardize the way users contribute to our projects by introducing dedicated commands
  • ensure that execution would be reproducible and standardized between environments (local, CI, etc...)

It could allow us to define several tasks to run which could help us to improve the project quality and stability by introducing specific and reproductible tasks like:

  • test execution
  • linters execution
  • auto formating code by using black
  • doc generation
  • release notes generation
  • etc

These changes drop the tests from the packaging, in other words pytest is no longer needed to build our packages, it's only installed and used for testing and during development lifecycle.

tox is a mainstream project used widely in by python community it could help us to standardize the way we tests and we develop on kinoml.

Also these changes could help us to reduce the cost to contribute to this project by providing mainstream features.

4383 avatar Apr 10 '20 15:04 4383

This pull request introduces 1 alert when merging 4b52571e9de7f0de06b42ee27a79e2970725b28c into 0db0487616d71fe32a9cd4590f808e25c6757a3a - view on LGTM.com

new alerts:

  • 1 for Unused import

lgtm-com[bot] avatar Apr 10 '20 15:04 lgtm-com[bot]

We generally have avoided tox since most of the CMS ecosystem requires conda and the two together require some hoops to jump through. We could consider having this as an option for the pip builds however.

dgasmith avatar Apr 15 '20 14:04 dgasmith

We generally have avoided tox since most of the CMS ecosystem requires conda and the two together require some hoops to jump through. We could consider having this as an option for the pip builds however.

Ok thanks for your feedback

4383 avatar Apr 15 '20 14:04 4383

Shall we close this issue?

FanwangM avatar Oct 25 '23 05:10 FanwangM