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 testing with tox #102

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Manage testing with tox #102

wants to merge 1 commit into from

Conversation

4383
Copy link

@4383 4383 commented Apr 10, 2020

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.

@lgtm-com
Copy link

lgtm-com bot commented Apr 10, 2020

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

new alerts:

  • 1 for Unused import

@4383 4383 force-pushed the tox branch 10 times, most recently from 3b5a648 to 168b507 Compare April 14, 2020 12:53
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
- 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.
@dgasmith
Copy link
Collaborator

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.

@4383
Copy link
Author

4383 commented Apr 15, 2020

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

@FanwangM
Copy link
Contributor

Shall we close this issue?

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

Successfully merging this pull request may close these issues.

3 participants