You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@steve.apache.org by Alan Cabrera <li...@toolazydogs.com> on 2013/06/03 22:23:06 UTC
Pythonic organization
Here's my current thinking. We would have two separate projects, one for a base library and command line tools and another for a gunicorn based web site.
Thoughts?
Regards,
Alan
Re: Pythonic organization
Posted by Greg Stein <gs...@gmail.com>.
On Fri, Jun 7, 2013 at 4:22 AM, Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> Greg Stein wrote on Fri, Jun 07, 2013 at 03:33:53 -0400:
>> Right. Generate docs via Sphinx, and commit them to svn. svnpubsub
>> will then publish that to the website.
>
> Other option: use the CMS with a build_cms.sh script that invokes
> scripts.
Sure. It seems Alan has an idea/guide on where to go with that. It
would be neat to tie it into the CMS system to enable quick-web-edits.
But that said, I'd much prefer *any* doc solution. It'll be /infinity/
better than the current doc :-P
Cheers,
-g
ps. /me wonders whether to "volunteer" danielsh into committer status.
he seem to be paying attention here... ;-)
Re: Pythonic organization
Posted by Greg Stein <gs...@gmail.com>.
On Thu, Jun 6, 2013 at 7:02 PM, Alan Cabrera <li...@toolazydogs.com> wrote:
> On Jun 3, 2013, at 2:36 PM, Greg Stein <gs...@gmail.com> wrote:
>...
>> The only question here, I believe, is whether we want to ship
>> documentation, or just refer people to our website. If we want to ship
>> docco, then it would go into trunk/. (and possibly incorporated
>> somehow into site/ by the tooling)
>
> I think that the Sphinx-licious docs should be on our website, read-the-docs, and delivered bundled in with the code so that consumers can generate their own Sphinx-licious docs.
Okay. Sounds like we want trunk/docs/, and we'll ship those and
generate them to steve/site/ as appropriate.
>> Note that steve.apache.org must be static (all sites at the ASF must
>> be static). We won't be allowed to use gunicorn, or similar.
>
> Sorry, I should have been more specific.
>
> By website I meant the voting website that's in this project. I thought that the release
Ah. Gotcha.
Right now, we have a perl CGI script to deal with the voting. And some
Apache HTTPd config bits.
The CGI scripts basically invoke the cmdline tools to make the work
happen. This is because we need the setuid bits on those tools.
I suspect that we can simply use wsgiref rather than needing to haul
in a gunicorn dependency. Structuring around wsgi means we could then
provide (via wiki? docs?) instructions for gunicorn, mod_wsgi, etc.
(and yes, the above implies rewriting the .pl CGI script into a wsgi app)
> cadences of both may be different and the way I'm used to delivering Python code is that command line and library code gets shipped together, like boto, and gunicorn websites get their own project. If there's a clean way to ship both together then I'm eager to see how.
The project is small. I'd suggest keeping everything in trunk/. We can
create a "dist.sh" to build distribution tarballs, pypi uploads, etc.
In the future, we can have dist.sh build multiple distros as needed.
But really: we're talking about a dozen scripts, some docco, and
another dozen misc files. Multiple distributions is probably harder
than needed.
(I believe pypi install will be the #1 delivery, and we likely want to
match expectations there)
> The project website, I agree, should be somewhat static though I imagine it will include Sphinx-licious docs.
Right. Generate docs via Sphinx, and commit them to svn. svnpubsub
will then publish that to the website.
Cheers,
-g
Re: [ANNOUNCE] Welcome Sean Kelly as Steve committer (was Re: Pythonic organization)
Posted by ke...@apache.org.
Thanks Chris. I cannot wait to commit some Python with eight space wide hard tabs.
I kid, I kid!
Thanks, everyone, for having me.
--Sean "Single Transferable Nutjob" Kelly
On 2013.Jun.7, at 4.04p, "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov> wrote:
> Thanks, Sean.
>
> The Steve PMC has VOTEd to add you as a committer on the project.
> Welcome!
>
> I've granted you karma on the bits. Enjoy hacking :)
>
> Cheers,
> Chris
>
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Chris Mattmann, Ph.D.
> Senior Computer Scientist
> NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
> Office: 171-266B, Mailstop: 171-246
> Email: chris.a.mattmann@nasa.gov
> WWW: http://sunset.usc.edu/~mattmann/
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Adjunct Assistant Professor, Computer Science Department
> University of Southern California, Los Angeles, CA 90089 USA
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
> -----Original Message-----
> From: "kelly@apache.org" <ke...@apache.org>
> Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
> Date: Friday, June 7, 2013 9:59 AM
> To: "dev@steve.apache.org" <de...@steve.apache.org>
> Subject: Re: Pythonic organization
>
>> After going blind from all the Perl code, you bet I'd be happy to help
>> out.
>>
>> Thanks
>> --k
>>
>> On 2013.Jun.7, at 11.39a, "Mattmann, Chris A (398J)"
>> <ch...@jpl.nasa.gov> wrote:
>>
>>> Thanks Sean.
>>>
>>> In the vein of Greg Stein's comment about Daniel, Sean, you interested
>>> in commit bit? :)
>>>
>>> Cheers,
>>> Chris
>>>
>>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>> Chris Mattmann, Ph.D.
>>> Senior Computer Scientist
>>> NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
>>> Office: 171-266B, Mailstop: 171-246
>>> Email: chris.a.mattmann@nasa.gov
>>> WWW: http://sunset.usc.edu/~mattmann/
>>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>> Adjunct Assistant Professor, Computer Science Department
>>> University of Southern California, Los Angeles, CA 90089 USA
>>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>>
>>>
>>>
>>>
>>>
>>>
>>> -----Original Message-----
>>> From: "kelly@apache.org" <ke...@apache.org>
>>> Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
>>> Date: Friday, June 7, 2013 9:37 AM
>>> To: "dev@steve.apache.org" <de...@steve.apache.org>
>>> Subject: Re: Pythonic organization
>>>
>>>>> I think that the Sphinx-licious docs should be on our website,
>>>>> read-the-docs, and delivered bundled in with the code so that
>>>>> consumers
>>>>> can generate their own Sphinx-licious docs.
>>>>
>>>> I like Sphinx. It's very, very Pythonic.
>>>>
>>>> --k
>>>
>>
>
[ANNOUNCE] Welcome Sean Kelly as Steve committer (was Re: Pythonic
organization)
Posted by "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov>.
Thanks, Sean.
The Steve PMC has VOTEd to add you as a committer on the project.
Welcome!
I've granted you karma on the bits. Enjoy hacking :)
Cheers,
Chris
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: chris.a.mattmann@nasa.gov
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: "kelly@apache.org" <ke...@apache.org>
Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
Date: Friday, June 7, 2013 9:59 AM
To: "dev@steve.apache.org" <de...@steve.apache.org>
Subject: Re: Pythonic organization
>After going blind from all the Perl code, you bet I'd be happy to help
>out.
>
>Thanks
>--k
>
>On 2013.Jun.7, at 11.39a, "Mattmann, Chris A (398J)"
><ch...@jpl.nasa.gov> wrote:
>
>> Thanks Sean.
>>
>> In the vein of Greg Stein's comment about Daniel, Sean, you interested
>> in commit bit? :)
>>
>> Cheers,
>> Chris
>>
>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>> Chris Mattmann, Ph.D.
>> Senior Computer Scientist
>> NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
>> Office: 171-266B, Mailstop: 171-246
>> Email: chris.a.mattmann@nasa.gov
>> WWW: http://sunset.usc.edu/~mattmann/
>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>> Adjunct Assistant Professor, Computer Science Department
>> University of Southern California, Los Angeles, CA 90089 USA
>> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>
>>
>>
>>
>>
>>
>> -----Original Message-----
>> From: "kelly@apache.org" <ke...@apache.org>
>> Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
>> Date: Friday, June 7, 2013 9:37 AM
>> To: "dev@steve.apache.org" <de...@steve.apache.org>
>> Subject: Re: Pythonic organization
>>
>>>> I think that the Sphinx-licious docs should be on our website,
>>>> read-the-docs, and delivered bundled in with the code so that
>>>>consumers
>>>> can generate their own Sphinx-licious docs.
>>>
>>> I like Sphinx. It's very, very Pythonic.
>>>
>>> --k
>>
>
Re: Pythonic organization
Posted by ke...@apache.org.
After going blind from all the Perl code, you bet I'd be happy to help out.
Thanks
--k
On 2013.Jun.7, at 11.39a, "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov> wrote:
> Thanks Sean.
>
> In the vein of Greg Stein's comment about Daniel, Sean, you interested
> in commit bit? :)
>
> Cheers,
> Chris
>
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Chris Mattmann, Ph.D.
> Senior Computer Scientist
> NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
> Office: 171-266B, Mailstop: 171-246
> Email: chris.a.mattmann@nasa.gov
> WWW: http://sunset.usc.edu/~mattmann/
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Adjunct Assistant Professor, Computer Science Department
> University of Southern California, Los Angeles, CA 90089 USA
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
> -----Original Message-----
> From: "kelly@apache.org" <ke...@apache.org>
> Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
> Date: Friday, June 7, 2013 9:37 AM
> To: "dev@steve.apache.org" <de...@steve.apache.org>
> Subject: Re: Pythonic organization
>
>>> I think that the Sphinx-licious docs should be on our website,
>>> read-the-docs, and delivered bundled in with the code so that consumers
>>> can generate their own Sphinx-licious docs.
>>
>> I like Sphinx. It's very, very Pythonic.
>>
>> --k
>
Re: Pythonic organization
Posted by "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov>.
Thanks Sean.
In the vein of Greg Stein's comment about Daniel, Sean, you interested
in commit bit? :)
Cheers,
Chris
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: chris.a.mattmann@nasa.gov
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: "kelly@apache.org" <ke...@apache.org>
Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
Date: Friday, June 7, 2013 9:37 AM
To: "dev@steve.apache.org" <de...@steve.apache.org>
Subject: Re: Pythonic organization
>> I think that the Sphinx-licious docs should be on our website,
>>read-the-docs, and delivered bundled in with the code so that consumers
>>can generate their own Sphinx-licious docs.
>
>I like Sphinx. It's very, very Pythonic.
>
>--k
Re: Pythonic organization
Posted by ke...@apache.org.
> I think that the Sphinx-licious docs should be on our website, read-the-docs, and delivered bundled in with the code so that consumers can generate their own Sphinx-licious docs.
I like Sphinx. It's very, very Pythonic.
--k
Re: Pythonic organization
Posted by Alan Cabrera <li...@toolazydogs.com>.
On Jun 3, 2013, at 2:36 PM, Greg Stein <gs...@gmail.com> wrote:
> On Mon, Jun 3, 2013 at 4:23 PM, Alan Cabrera <li...@toolazydogs.com> wrote:
>> Here's my current thinking. We would have two separate projects, one for a base library and command line tools and another for a gunicorn based web site.
>>
>> Thoughts?
>
> I assume you mean something like:
>
> repos/asf/steve/
> trunk/
> tags/
> branches/
> site/
>
> Where the Steve code goes into trunk/tags/branches as usual, and the
> site/ directory contains the web site tooling/content.
>
> The only question here, I believe, is whether we want to ship
> documentation, or just refer people to our website. If we want to ship
> docco, then it would go into trunk/. (and possibly incorporated
> somehow into site/ by the tooling)
I think that the Sphinx-licious docs should be on our website, read-the-docs, and delivered bundled in with the code so that consumers can generate their own Sphinx-licious docs.
> Note that steve.apache.org must be static (all sites at the ASF must
> be static). We won't be allowed to use gunicorn, or similar.
Sorry, I should have been more specific.
By website I meant the voting website that's in this project. I thought that the release cadences of both may be different and the way I'm used to delivering Python code is that command line and library code gets shipped together, like boto, and gunicorn websites get their own project. If there's a clean way to ship both together then I'm eager to see how.
The project website, I agree, should be somewhat static though I imagine it will include Sphinx-licious docs.
Regards,
Alan
Re: Pythonic organization
Posted by Greg Stein <gs...@gmail.com>.
On Mon, Jun 3, 2013 at 4:23 PM, Alan Cabrera <li...@toolazydogs.com> wrote:
> Here's my current thinking. We would have two separate projects, one for a base library and command line tools and another for a gunicorn based web site.
>
> Thoughts?
I assume you mean something like:
repos/asf/steve/
trunk/
tags/
branches/
site/
Where the Steve code goes into trunk/tags/branches as usual, and the
site/ directory contains the web site tooling/content.
The only question here, I believe, is whether we want to ship
documentation, or just refer people to our website. If we want to ship
docco, then it would go into trunk/. (and possibly incorporated
somehow into site/ by the tooling)
Note that steve.apache.org must be static (all sites at the ASF must
be static). We won't be allowed to use gunicorn, or similar.
Cheers,
-g
Re: Pythonic organization
Posted by "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov>.
Ah just read the first 2 parts -- about the cmd line lib; and the API
lib. I just read Greg's thing about gunicorn so we'll have to work around
the fact that we can't use that. But +1 to having a cmd line lib and
an API lib.
Cheers,
Chris
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: chris.a.mattmann@nasa.gov
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: <Mattmann>, jpluser <ch...@jpl.nasa.gov>
Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
Date: Monday, June 3, 2013 10:53 PM
To: "dev@steve.apache.org" <de...@steve.apache.org>
Subject: Re: Pythonic organization
>+1 makes sense to me.
>
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Chris Mattmann, Ph.D.
>Senior Computer Scientist
>NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
>Office: 171-266B, Mailstop: 171-246
>Email: chris.a.mattmann@nasa.gov
>WWW: http://sunset.usc.edu/~mattmann/
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Adjunct Assistant Professor, Computer Science Department
>University of Southern California, Los Angeles, CA 90089 USA
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
>-----Original Message-----
>From: Alan Cabrera <li...@toolazydogs.com>
>Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
>Date: Monday, June 3, 2013 1:23 PM
>To: "dev@steve.apache.org" <de...@steve.apache.org>
>Subject: Pythonic organization
>
>>Here's my current thinking. We would have two separate projects, one for
>>a base library and command line tools and another for a gunicorn based
>>web site.
>>
>>Thoughts?
>>
>>
>>Regards,
>>Alan
>>
>
Re: Pythonic organization
Posted by "Mattmann, Chris A (398J)" <ch...@jpl.nasa.gov>.
+1 makes sense to me.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: chris.a.mattmann@nasa.gov
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: Alan Cabrera <li...@toolazydogs.com>
Reply-To: "dev@steve.apache.org" <de...@steve.apache.org>
Date: Monday, June 3, 2013 1:23 PM
To: "dev@steve.apache.org" <de...@steve.apache.org>
Subject: Pythonic organization
>Here's my current thinking. We would have two separate projects, one for
>a base library and command line tools and another for a gunicorn based
>web site.
>
>Thoughts?
>
>
>Regards,
>Alan
>