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

Migrate coverage configurations to pyproject.toml #667

Merged
merged 1 commit into from
Nov 16, 2020
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Oct 23, 2020

Description of proposed changes

The project is using many different tools (e.g., black, coverage) and each tool may have many configurations, saved in different configurations files (e.g., .coveragerc, setup.cfg). PEP 518 introduced a standard configuration file pyproject.toml where tools can put their configurations.

This PR tries to migrate the coverage configurations from .coveragerc to pyproject.toml. We may migrate more configurations (e.g., black, pytest, setuptools-scm) in separate PRs.

Coverage configurations: https://coverage.readthedocs.io/en/latest/config.html

References:

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@weiji14 weiji14 added the maintenance Boring but important stuff for the core devs label Oct 24, 2020
@seisman seisman changed the title Migrate configurations to pyproject.toml Migrate coverage configurations to pyproject.toml Nov 16, 2020
@seisman seisman marked this pull request as ready for review November 16, 2020 01:35
@seisman seisman added this to the 0.2.2 milestone Nov 16, 2020
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR tries to migrate the coverage configurations from .coveragerc to pyproject.toml. We may migrate more configurations (e.g., black, pytest, setuptools-scm) in separate PRs.

Fully support this step-by-step move of all the configurations to pyproject.toml. Have a look too at https://python-poetry.org/ when you have time!

@seisman seisman merged commit 2ee9b34 into master Nov 16, 2020
@seisman seisman deleted the pyproject branch November 16, 2020 02:14
@seisman seisman modified the milestones: 0.2.2, 0.3.0 Nov 21, 2020
@seisman
Copy link
Member Author

seisman commented Dec 18, 2020

Have a look too at https://python-poetry.org/ when you have time!

Read a little bit about poetry, but it seems poetry still doesn't officially support dynamic versioning from setuptools_scm. See python-poetry/poetry#140, python-poetry/poetry#693, https://github.com/mtkennerly/poetry-dynamic-versioning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants