cyrillefrancois / openlca2bw

Other
9 stars 5 forks source link

Versioning and formal package final details #5

Closed shirubana closed 1 year ago

shirubana commented 1 year ago

Hi Cyrille,

finished adding some mroe details to make this follow the open-source package details, such as being able to install with PyPI and keeping version details. Hopefully this helps also as a future example for when you release more software :)

I would sugggest you do the pypi release of your current working version for yoruself , even if you edit/fix stuff later on (and do new releases every so often).

One thing I haven't mentioend is that you might want to also (before doing hte release) open and 'link' a Zenodo account, so you also get a DOI number for every releaes and your package which you can use to cite on your resume and in publications formally :)

Let me know if you have any questions or need more support or changes.

S.

cyrillefrancois commented 1 year ago

I have tried to release on pypi. But when I build a package, python -m build it does not consider any version, even if I create tags. So my wheel and my tar have names as openlca2bw-0+untagged.41.g5282aa0.dirty.tar.gz So when I upload on pypi (or testpypi) I get error due to invalid version. Any clue ?

shirubana commented 1 year ago

Pull the repo to your computer after the release, I see you published v1.0.0 and you'd says 0.41... also of there is a dist or wheel folders, delete whatever is inside (from the failed push)

Keep me updated. The first time sometimes there are things to iron out that's why I have cookbook, I'm not very good at this part

Sent via the Samsung Galaxy S10, an AT&T 5G Evolution capable smartphone Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: cyrillefrancois @.> Sent: Tuesday, October 4, 2022 6:06:05 PM To: cyrillefrancois/openlca2bw @.> Cc: Ovaitt, Silvana @.>; Author @.> Subject: Re: [cyrillefrancois/openlca2bw] Versioning and formal package final details (PR #5)

CAUTION: This email originated from outside of NREL. Do not click links or open attachments unless you recognize the sender and know the content is safe.

I have tried to release on pypi. But when I build a package, python -m build it does not consider any version, even if I create tags. So my wheel and my tar have names as openlca2bw-0+untagged.41.g5282aa0.dirty.tar.gz So when I upload on pypi (or testpypi) I get error due to invalid version. Any clue ?

— Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcyrillefrancois%2Fopenlca2bw%2Fpull%2F5%23issuecomment-1267234714&data=05%7C01%7CSilvana.Ovaitt%40nrel.gov%7Caf448b22cf6d47feda0408daa6225814%7Ca0f29d7e28cd4f5484427885aee7c080%7C0%7C0%7C638004963702104496%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=7A68DlgSdiOQCuzzB4XSM%2FkcPQ3ZWvX8lHXCut0GF5E%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAFOEOZRB56VZEQUHZDYC6O3WBRIW3ANCNFSM6AAAAAAQ3NAB2Y&data=05%7C01%7CSilvana.Ovaitt%40nrel.gov%7Caf448b22cf6d47feda0408daa6225814%7Ca0f29d7e28cd4f5484427885aee7c080%7C0%7C0%7C638004963702104496%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=qLgqspcBVZl%2BafR7ndOOO88kJDOV%2BSDPWMwsF2vARSQ%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>

cyrillefrancois commented 1 year ago

I find a way, I used 'pep440-old' to get a version accepted by PyPi.