[Kss-devel] will megrok.kss ever go "live"?

[Godefroid Chapelle]

Balazs Ree wrote:
> On Tue, 08 Apr 2008 13:28:39 +0200, Godefroid Chapelle wrote:
> 
>> Balazs Ree wrote:
>>> On Tue, 08 Apr 2008 11:45:31 +0200, Godefroid Chapelle wrote:
>>>> Brandon Craig Rhodes wrote:
>>>>> Godefroid Chapelle <gotcha at bubblenet.be>
>>>>> writes:
>>>>> Is there a "What's New" document somewhere describing what features
>>>>> it gains in 1.4?  There's no real documentation or description
>>>>> offered on the PyPi page.
>>>> We should do that documentation :
>>>>
>>>> In the meanwhile, you can look at
>>>>
>>>> http://codespeak.net/svn/kukit/kukit.js/branch/1.4/doc/HISTORY.txt
>>> I attempted to do this, please take a look here:
>>>
>>> https://codespeak.net/svn/kukit/kss.core/branch/1.4/docs/NEWS.txt
>>>
>>> Maybe, we need to extend this NEWS.txt file a bit (tell about the
>>> earlier versions too) and use it as a description from setup.py, that
>>> way it would end up on the pypi page.
>>>
>>>
>> Good idea.
>>
>> We could concat NEWS.txt to static text in the long description
> 
> 
> I stole this entirely from zc.buildout:

I had guessed so ;-)

> 
> ---------------------
> 
> 
> def read(*rnames):
>     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
> 
> long_description=(
>         read('README.txt')
>         + '\n' +
>         'Detailed Documentation\n'
>         '**********************\n'
>         + '\n' +
>         read('src', 'zc', 'buildout', 'buildout.txt')
>         + '\n' +
> ...
>         + '\n' +
>         read('CHANGES.txt')
>         + '\n' +
>         'Download\n'
>         '**********************\n'
>         )
> 
> ...
> 
> name = "zc.buildout"
> setup(
>     name = name,
>     version = version,
>     author = "Jim Fulton",
>     author_email = "jim at zope.com",
>     description = "System for managing development buildouts",
>     long_description=long_description,
>     ...
> 
> I believe we could do the same with some additional content, NEWS.txt
> could be the part of it but we probably want some brief description
> of kss copied from the kssproject.org frontpage to an kssintro.txt, 

I would keep it in README.txt

> as well as a link to the project page.

+1

> 
> Afaik, the description must be in ReST so that is already what we have.
> 

Add it if you find time ;-)
-- 
Godefroid Chapelle (aka __gotcha) http://bubblenet.be