Re: PyPI question, or, maybe I'm just stupid
Chris Gonnerman ch...@gonnerman.org writes: I've been making some minor updates to the PollyReports module I announced a while back, and I've noticed that when I upload it to PyPI, my changelog (CHANGES.txt) doesn't appear to be integrated into the site at all. Do I have to put the changes into the README, or have I missed something here? It seems that there should be some automatic method whereby PyPI users could easily see what I've changed without downloading it first. CHANGES.txt is not automatically presented. If necessary, you must integrate it into the long description. However, personally, I am not interested in all the details (typically found in CHANGES.txt) but some (often implicit) information is sufficient for me: something like major API change, minor bug fixes. Thus, think carefully what you put on the overview page. I find it very stupid to see several window scrolls of changes for a package but to learn how to install the package, I have to download its source... -- http://mail.python.org/mailman/listinfo/python-list
Re: [Python] Re: PyPI question, or, maybe I'm just stupid
On 07/30/2012 04:20 AM, Dieter Maurer wrote: CHANGES.txt is not automatically presented. If necessary, you must integrate it into the long description. However, personally, I am not interested in all the details (typically found in CHANGES.txt) but some (often implicit) information is sufficient for me: something like major API change, minor bug fixes. Thus, think carefully what you put on the overview page. I see your point. I'm just lazy, I guess. I already put a description of what I've changed into git, so why, I muse, must I also edit the overview page separately? I was hoping there was an automatic way that setup.py sdist upload could handle it for me. I find it very stupid to see several window scrolls of changes for a package but to learn how to install the package, I have to download its source... Not sure I get this. The installation procedure for PollyReports is the same as for, what, 99% of Python source packages? sudo python setup.py install What else are you saying I should do? -- Chris. -- http://mail.python.org/mailman/listinfo/python-list
Re: [Python] Re: PyPI question, or, maybe I'm just stupid
On 07/29/2012 11:00 PM, Ben Finney wrote: Your post is showing up as a reply to a thread about IEEE-784 floats, because you created your message as a reply. Consequently, it's rather confusing why you suddenly start talking about PollyReports. If you want to attract attention to an unrelated topic, it's best if you don't reply to an existing thread; instead, start a new thread by composing a new message to the forum. My apologies. I did not consider that headers I can't see might be being sent along. -- http://mail.python.org/mailman/listinfo/python-list
RE: [Python] Re: PyPI question, or, maybe I'm just stupid
However, personally, I am not interested in all the details (typically found in CHANGES.txt) but some (often implicit) information is sufficient for me: something like major API change, minor bug fixes. Thus, think carefully what you put on the overview page. I see your point. I'm just lazy, I guess. I already put a description of what I've changed into git, so why, I muse, must I also edit the overview page separately? I was hoping there was an automatic way that setup.py sdist upload could handle it for me. Even if you could include commit messages I would not recommend it. Commit messages are for developers of _your_ package not users. It is like leaving a memo (cough or message) for future developers. As a user, I want to know that you added a feature AAA. I do *not* want to know that in order to add AAA you also had to modify BBB and create CCC. Maybe you had to revert BBB because it conflicted with DDD and then you refactored some code and added/updated comments. Finally you managed to fix BBB (maybe also modifying DDD?) and so the feature AAA is now available. Ramit This email is confidential and subject to important disclaimers and conditions including on offers for the purchase or sale of securities, accuracy and completeness of information, viruses, confidentiality, legal privilege, and legal entity disclaimers, available at http://www.jpmorgan.com/pages/disclosures/email. -- http://mail.python.org/mailman/listinfo/python-list
Re: [Python] Re: PyPI question, or, maybe I'm just stupid
Chris Gonnerman ch...@gonnerman.org writes: On 07/30/2012 04:20 AM, Dieter Maurer wrote: ... I find it very stupid to see several window scrolls of changes for a package but to learn how to install the package, I have to download its source... Not sure I get this. The installation procedure for PollyReports is the same as for, what, 99% of Python source packages? sudo python setup.py install What else are you saying I should do? This remark was not targeted at PollyReports but (in general) at packages with non-trivial installation procedures which nevertheless state on the overview page for installation read the separate installation instructions (in the source distribution). As a side note: playing well with python package managers (easy_install, pip, zc.buildout, ...) could make it even simpler than sudo python setup.py install. -- http://mail.python.org/mailman/listinfo/python-list
PyPI question, or, maybe I'm just stupid
I've been making some minor updates to the PollyReports module I announced a while back, and I've noticed that when I upload it to PyPI, my changelog (CHANGES.txt) doesn't appear to be integrated into the site at all. Do I have to put the changes into the README, or have I missed something here? It seems that there should be some automatic method whereby PyPI users could easily see what I've changed without downloading it first. -- http://mail.python.org/mailman/listinfo/python-list
Re: PyPI question, or, maybe I'm just stupid
Chris Gonnerman ch...@gonnerman.org writes: I've been making some minor updates to the PollyReports module Your post is showing up as a reply to a thread about IEEE-784 floats, because you created your message as a reply. Consequently, it's rather confusing why you suddenly start talking about PollyReports. If you want to attract attention to an unrelated topic, it's best if you don't reply to an existing thread; instead, start a new thread by composing a new message to the forum. -- \“I'd take the awe of understanding over the awe of ignorance | `\ any day.” —Douglas Adams | _o__) | Ben Finney -- http://mail.python.org/mailman/listinfo/python-list
