I can create README.md but I can't use CHANGELOG.md

[Drill-N-Bass]

hello,

I'm using REDME.md version of the file, so I can do markdowns in the description of my module in pypi.org, but when I try to do the same with CHANGELOG file, it works on the site:

...but It doesn't in Jupyter notebook:

Describe the solution you'd like I want to have the same ability to create markdowns with CHANGELOG as I have with the README file. Additional context Below I paste the code that works (but CHANGELOG is TXT):

The version below works on pypi.org page, but throw an error in Jupyter Notebook:

My module: https://pypi.org/project/get-gifNimage/

[henryiii]

I think you need to add CHANGELOG.md to your MANIFEST.in. I'm guessing CHANGELOG.txt got added there at some point? Since it's not a default in https://packaging.python.org/guides/using-manifest-in/ . Also I recommend always providing wheels for pure python packages.

[Drill-N-Bass]

I think you need to add CHANGELOG.md to your MANIFEST.in. I'm guessing CHANGELOG.txt got added there at some point?

That was it! Thank you! :)

Also I recommend always providing wheels for pure python packages.

It's my first module and I'm a newbie: I don't even know if I provide wheels, or not. I was using 5 sources to build my module because I couldn't find one that would work (there is no good guide for Windows). Could you tell me where I can find the most full and understandable guide for this wheel issue you mentioned?

[henryiii]

This one is pretty well kept up-to-date: https://packaging.python.org/tutorials/packaging-projects/

Basically, if you use pip install build then python -m build, that will make both an SDist and wheel by default. (Or, for windows, py -m build I'd guess? Also could use pipx run build if you have pipx). As long as it's not partially compiled, you'll get a wheel that works everywhere.

[Drill-N-Bass]

I'm sorry, but I don't understand almost nothing from your reply.

According to the link you posted I add pyproject.toml file with mentioned content. But after I compress it in Windows powershell with: python setup.py sdist - it doesn't create .whl file. I assume it should. Maybe I don't understand some steps, but I don't see any place where is really well explained, to be honest.

I can't check is this wheel instalation works (assuming that sdist done its job), because I can't install anything in this format: Ive gotten output that I should update pip. But when I tried to update pip, the output was: there is no pip. I don't understand why, because I add python/scripts to system/environment variables. From some reason I have 6 python.exe files on the drive.

Now I wonder, why I need wheel? It works with pip install in jupyter notebook (no idea why, but it works). After 6h of trying this wheel stuff Im in the starting point.

Few months ago I update python to 3.8v. After that it stopped working. When I uninstalled it and got back to 3.7 few things stopped working, but, at least jupyter was alive again, so I could learn python further..

I'm grateful for your help, because with pip my first library works ( so I have my code in my library on pypi.org - all of that took me month). At this point I think will get back to study regex and using my new library in my projects and thats it.

Thank you once again. Your answer was the last step in the core goal that I did.

Paul

W dniu 7 maj 2021, 16:32, o 16:32, użytkownik Henry Schreiner @.***> napisał:

This one is pretty well kept up-to-date: https://packaging.python.org/tutorials/packaging-projects/

Basically, if you use pip install build then python -m build, that will make both an SDist and wheel by default. (Or, for windows, py -m build I'd guess? Also could use pipx run build if you have pipx). As long as it's not partially compiled, you'll get a wheel that works everywhere.

-- You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: https://github.com/pypa/packaging-problems/issues/508#issuecomment-834459207