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

Merge configurations into pyproject.toml #1073

Merged
merged 12 commits into from
May 31, 2024

Conversation

fwitte
Copy link
Member

@fwitte fwitte commented May 30, 2024

Resolve #1072
Resolve #712

@fwitte
Copy link
Member Author

fwitte commented May 30, 2024

@oemof-developer: I think this should be ready for review. There are two remaining questions:

  • Is anybody knowledgeable if pydocstyle actually does anything?
  • The black error is in some source files I never touched, should that be fixed or not?

Quick explanation/overview of the changes:

  • setup.cfg (deleted)
    • flake8 related stuff moved to new file: .flake8
    • pep257 deleted, seems to be the same as pydocstyle
    • everything else moved to pyproject.toml
  • setup.py, MANIFEST.in (all deleted)
    • completely migrated to pyproject.toml
  • .prospector (deleted)
    • same as pydocstyle and pep257, does not seem to affect any test

@fwitte
Copy link
Member Author

fwitte commented May 30, 2024

One more comment to the build system: I changed from setuptools to flit, because setuptools based on pyproject.toml did not support pip install -e last time I checked, and also because I am using it in other tools, where I migrated to pyproject.toml, e.g. tespy.

I am very open to discuss this btw. because I am by no means an expert in this, according to this post, it seems setuptools should provide editable installation for pure pyproject.toml as well: https://stackoverflow.com/questions/69711606/how-to-install-a-package-using-pip-in-editable-mode-with-pyproject-toml

Copy link
Member

@p-snft p-snft left a comment

Choose a reason for hiding this comment

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

First of all, you questions:

Is anybody knowledgeable if pydocstyle actually does anything?

I don't but I think this is nothing to be fixed here. If it does not do anything, it should be removed independend from the switch to pyproject.toml.

The black error is in some source files I never touched, should that be fixed or not?

This is an unrelated problem, as it should have been wrong before you changed things. So, it should not be included in this merge request.

The same is true for the last comment I gave. Making support for Python 3.11 (which is tested) official might be something for a separate merge.

PS: I was a bit surprised that https://github.com/oemof/oemof/wiki/How-to-release still works exactly the same way as before.

pyproject.toml Outdated Show resolved Hide resolved
@fwitte
Copy link
Member Author

fwitte commented May 30, 2024

One more question, what is the VERSION file for?

VERSION was deleted, also see #712

pyproject.toml Show resolved Hide resolved
@p-snft p-snft mentioned this pull request May 31, 2024
@p-snft p-snft merged commit 2cba242 into dev May 31, 2024
12 of 14 checks passed
@p-snft p-snft deleted the fix/#1072-merge-and-clean-configuration-files branch June 4, 2024 10:41
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.

Aggregate all sorts of tools configurations in pyproject.toml Define version at a single location
2 participants