Skip to content

Migrate coverage configurations to pyproject.toml - #667

Merged
seisman merged 1 commit into
masterfrom
pyproject
Nov 16, 2020
Merged

Migrate coverage configurations to pyproject.toml#667
seisman merged 1 commit into
masterfrom
pyproject

Conversation

@seisman

@seismanseisman commented Oct 23, 2020

Copy link
Copy Markdown
Member

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.

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

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

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 masterNov 16, 2020
@seisman
seisman deleted the pyproject branch November 16, 2020 02:14
@seismanseisman modified the milestones: 0.2.2, 0.3.0Nov 21, 2020
@seisman

Copy link
Copy Markdown
MemberAuthor

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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenanceBoring but important stuff for the core devs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman@weiji14