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

Use setuptools-scm / pyproject.toml (modern packaging) #364

Merged
merged 1 commit into from
Dec 19, 2023

Conversation

sim0nx
Copy link
Contributor

@sim0nx sim0nx commented Dec 19, 2023

  • migrate setup.py to pyproject.toml
  • use setuptools-scm

fixes #357

Please note that in order to build packages, you should after merging this, do the following:

pip install -U pip build
python -m build

The version variable will be available just as before, but auto-generated.

Ref: https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives

@sim0nx sim0nx closed this Dec 19, 2023
@sim0nx sim0nx force-pushed the pyproject_toml_setuptools_scm branch from c6d7e57 to 722e9c0 Compare December 19, 2023 16:36
@sim0nx sim0nx reopened this Dec 19, 2023
@sim0nx sim0nx force-pushed the pyproject_toml_setuptools_scm branch 2 times, most recently from 49a8efd to 9a75056 Compare December 19, 2023 17:09
@tobixen
Copy link
Member

tobixen commented Dec 19, 2023

Please note that in order to build packages, you should after merging this, do the following:

pip install -U pip build
python -m build

This should probably be included in the documentation

@sim0nx sim0nx force-pushed the pyproject_toml_setuptools_scm branch from 9a75056 to 68d4d4c Compare December 19, 2023 17:15
@sim0nx
Copy link
Contributor Author

sim0nx commented Dec 19, 2023

Please note that in order to build packages, you should after merging this, do the following:

pip install -U pip build
python -m build

This should probably be included in the documentation

updated release-howto.md

@tobixen
Copy link
Member

tobixen commented Dec 19, 2023

Another thing, the RELEASE-HOWTO.md probably needs some modifications (after several really silly embarrassing mistakes while releasing, I've made a rather complicated procedure to make sure I'm on the correct branch, that the version number is updated, that the tag is correct and that I'm doing the dist from a clean checkout - I suppose some of the steps may be sidestepped now).

@tobixen
Copy link
Member

tobixen commented Dec 19, 2023

Seems like my last comment was posted some seconds too late :-)

@sim0nx sim0nx force-pushed the pyproject_toml_setuptools_scm branch from 68d4d4c to ba6cad4 Compare December 19, 2023 17:19
@tobixen
Copy link
Member

tobixen commented Dec 19, 2023

Or maybe not. There are still some steps in the RELEASE-HOWTO that doesn't make sense now I think (like grepping for the version number from __init__.py)

@sim0nx sim0nx force-pushed the pyproject_toml_setuptools_scm branch from ba6cad4 to bf8e70c Compare December 19, 2023 17:21
@sim0nx
Copy link
Contributor Author

sim0nx commented Dec 19, 2023

I removed those obsolete parts. Should hopefully be fine now :-)

@tobixen tobixen added this pull request to the merge queue Dec 19, 2023
Merged via the queue into python-caldav:master with commit 70e7856 Dec 19, 2023
7 checks passed
@sim0nx sim0nx deleted the pyproject_toml_setuptools_scm branch December 19, 2023 17:27
@tobixen
Copy link
Member

tobixen commented Dec 19, 2023

>>> import caldav
>>> caldav.__version__
'1.3.10.dev4+g70e7856.d20231219'

lovely :-)

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.

Look into setuptools-scm
2 participants