Closed ebrahimebrahim closed 6 months ago
The idiomatic way to say "this isn't ready" is to set a development status classifier - Development Status :: 1 - Planning
or Development Status :: 2 - Pre-Alpha
- and to set a 0.X.Y version number. We'd set the version number with a github release tag since we're using setuptools_scm
.
It looks like the template already set status 1, which is probably fine.
A subheading or something at the top of the README is not a bad idea.
I see, ty I was wondering about that.
Yes I was going to tag with 0.1.0 for the first release
We'll fill out the readme pretty soon I imagine
@allemangD Added a blurb to the readme, ready for another look
This won't do anything till we create a GitHub release from a tag. I'll go ahead and merge.
We also need to reserve the name on PyPI so there's a location for the CI to upload. I can go ahead and do this. @ebrahimebrahim are you https://pypi.org/user/ebrahimebrahim/? I'll grant you owner access if so.
This won't do anything till we create a GitHub release from a tag. I'll go ahead and merge.
We also need to reserve the name on PyPI so there's a location for the CI to upload. I can go ahead and do this. @ebrahimebrahim are you https://pypi.org/user/ebrahimebrahim/? I'll grant you owner access if so.
I've already done it I think -- I'm about to tag a release soon. Don't do it yet please I am trying to learn how this process works for myself :smile:
Maybe I haven't reserved a name yet, let me see what happens (I did reserve it)
(but yes I am that user)
You'll need to follow the steps https://packaging.python.org/en/latest/tutorials/packaging-projects/ and https://docs.pypi.org/trusted-publishers/adding-a-publisher/ to create the package on your account. I'd do the tag first so it has a sensible version without +dev...
suffix. Say v0.0.0
, so when you create a v0.0.1
release on GitHub we can verify the github action.
Yes, tagging and releasing now with v0.1.0
Interesting, we got
ERROR HTTPError: 400 Bad Request from https://upload.pypi.org/legacy/
Can't have direct dependency: HD-BET@
https://github.com/brain-microstructure-exploration-tools/HD-BET/archiv
e/refs/tags/v1.0.0.zip#sha[25](https://github.com/brain-microstructure-exploration-tools/abcd-microstructure-pipelines/actions/runs/9003846883/job/24735448038#step:4:26)6=d48908854207b839552f2059c9cf2a48819b847bc
1eb0ea4445d1d589471a1f5. See
https://packaging.python.org/specifications/core-metadata for more
information.
I will leave a note on PyPI for this project saying that it is not ready for prime time. I just want to start the CD process