Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
On Aug 20, 2007, at 8:22 PM, Stephan Richter wrote: On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: * Please also don't forget to add a changelog entry in README.txt, especially if you're adding features. If there's no README.txt yet, this is a good time to give it one. It should start out with a simple paragraph and have at least one section called "Changes". You could then use its contents as the long_description in setup.py. Other packages (e.g. zope.proxy or zope.publisher) can serve as examples. Why do the changes have to be part of the README file? That seems no good. I think a separate file is much better. If you use a separate file, and you are going to create a source distribution, then you need to have extra magic in your setup.py to include CHANGES.txt in the distribution. IMO, setup magic is bad. I'd prefer to see simpler setup.py files and thus I prefer to include the change log in README.txt. Jim -- Jim Fulton mailto:[EMAIL PROTECTED]Python Powered! CTO (540) 361-1714 http://www.python.org Zope Corporationhttp://www.zope.com http://www.zope.org ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
On 21 Aug 2007, at 19:51 , Andreas Jung wrote: --On 20. August 2007 20:22:50 -0400 Stephan Richter <[EMAIL PROTECTED]> wrote: On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: * Please also don't forget to add a changelog entry in README.txt, especially if you're adding features. If there's no README.txt yet, this is a good time to give it one. It should start out with a simple paragraph and have at least one section called "Changes". You could then use its contents as the long_description in setup.py. Other packages (e.g. zope.proxy or zope.publisher) can serve as examples. Why do the changes have to be part of the README file? That seems no good. I think a separate file is much better. I also prefer having separated files for the README and the changes. You can easily concatenate both files within your setup.py to generate the long_description. I doing this for my own projects. I don't care *where* the changelog goes, as long as it's properly maintained and preferrably shows up at the bottom of the CheeseShop page. ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
--On 20. August 2007 20:22:50 -0400 Stephan Richter <[EMAIL PROTECTED]> wrote: On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: * Please also don't forget to add a changelog entry in README.txt, especially if you're adding features. If there's no README.txt yet, this is a good time to give it one. It should start out with a simple paragraph and have at least one section called "Changes". You could then use its contents as the long_description in setup.py. Other packages (e.g. zope.proxy or zope.publisher) can serve as examples. Why do the changes have to be part of the README file? That seems no good. I think a separate file is much better. I also prefer having separated files for the README and the changes. You can easily concatenate both files within your setup.py to generate the long_description. I doing this for my own projects. Andreas pgp7HWwT2N7Rx.pgp Description: PGP signature ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
Stephan Richter wrote at 2007-8-20 20:22 -0400: >On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: >> * Please also don't forget to add a changelog entry in README.txt, >> especially if you're adding features. If there's no README.txt yet, this >> is a good time to give it one. It should start out with a simple >> paragraph and have at least one section called "Changes". You could then >> use its contents as the long_description in setup.py. Other packages >> (e.g. zope.proxy or zope.publisher) can serve as examples. > >Why do the changes have to be part of the README file? That seems no good. I >think a separate file is much better. When I read announcements, they usually report about relevant changes -- such that I can decide whether an upgrade offsets the effort and the risk of incompatibilities. The package information on Pypi may well have an announcement character... -- Dieter ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
On Aug 21, 2007, at 2:34 AM, Wichert Akkerman wrote: ... If you really want to you can combine both files in the long_description from your setup.py. That can make your cheesehop package page overly large though. How so? I think as long as a the long description has a table of contents at the top, I don't think that size is an issue. Note that with the latest version of buildout, buildout uses the new simple index, http://cheeseshop.python.org/simple by default, so there is no longer a buildout performance penalty for having large cheeseshop pages. Jim -- Jim Fulton mailto:[EMAIL PROTECTED]Python Powered! CTO (540) 361-1714 http://www.python.org Zope Corporationhttp://www.zope.com http://www.zope.org ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
On Tuesday 21 August 2007 02:34, Wichert Akkerman wrote: > If you really want to you can combine both files in the long_description > from your setup.py. That can make your cheesehop package page overly > large though. Jim suggested that we should put all documentation in the long description, so that the PyPI page can serve as a home page for libraries. I followed that suggestion and it works out fairly well. The page is long, but it is worth having the docs online. Regards, Stephan -- Stephan Richter CBU Physics & Chemistry (B.S.) / Tufts Physics (Ph.D. student) Web2k - Web Software Design, Development and Training ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
Previously Stephan Richter wrote: > On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: > > * Please also don't forget to add a changelog entry in README.txt, > > especially if you're adding features. If there's no README.txt yet, this > > is a good time to give it one. It should start out with a simple > > paragraph and have at least one section called "Changes". You could then > > use its contents as the long_description in setup.py. Other packages > > (e.g. zope.proxy or zope.publisher) can serve as examples. > > Why do the changes have to be part of the README file? That seems no good. I > think a separate file is much better. +1 The audience for changelog information is different than the audience for normal documentation. If you really want to you can combine both files in the long_description from your setup.py. That can make your cheesehop package page overly large though. Wichert. -- Wichert Akkerman <[EMAIL PROTECTED]>It is simple to make things. http://www.wiggy.net/ It is hard to make things simple. ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote: > * Please also don't forget to add a changelog entry in README.txt, > especially if you're adding features. If there's no README.txt yet, this > is a good time to give it one. It should start out with a simple > paragraph and have at least one section called "Changes". You could then > use its contents as the long_description in setup.py. Other packages > (e.g. zope.proxy or zope.publisher) can serve as examples. Why do the changes have to be part of the README file? That seems no good. I think a separate file is much better. Regards, Stephan -- Stephan Richter CBU Physics & Chemistry (B.S.) / Tufts Physics (Ph.D. student) Web2k - Web Software Design, Development and Training ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
[Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org
Some notes on the release process here: * Please also don't forget to add a changelog entry in README.txt, especially if you're adding features. If there's no README.txt yet, this is a good time to give it one. It should start out with a simple paragraph and have at least one section called "Changes". You could then use its contents as the long_description in setup.py. Other packages (e.g. zope.proxy or zope.publisher) can serve as examples. * I see that zope.location 3.4.0b1 is out as several "continuous releases". This model sucks, IMO. I think it's time to tg 3.4.0b1 and push it out as a release, not only to download.zope.org but also to the CheeseShop (which is much more usable with ppix now, so I less and less see the need for download.zope.org). Whenever I've come across a package that I've worked on in the past few weeks, I've done the things I described above. I know it takes you a couple of minutes, but those are well-invested, I think (packages will appear as a decent release with at least some kind of decent front page on the CheeseShop, and the changelog is properly taken care of). Christian Zagrodnick wrote: Log message for revision 78904: using pypi as homepage instead of svn.zope.org Changed: U zope.location/trunk/setup.py -=- Modified: zope.location/trunk/setup.py === --- zope.location/trunk/setup.py2007-08-17 12:06:10 UTC (rev 78903) +++ zope.location/trunk/setup.py2007-08-17 12:11:43 UTC (rev 78904) @@ -22,9 +22,9 @@ setup(name='zope.location', version = '3.4.0b1', - url='http://svn.zope.org/zope.location', + url='http://pypi.python.org/pypi/zope.location/', license='ZPL 2.1', - description='Zope Proxies', + description='Zope Location', author='Zope Corporation and Contributors', author_email='zope3-dev@zope.org', long_description="In Zope3, location are special objects" -- http://worldcookery.com -- Professional Zope documentation and training ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
