Status of quick_traversal/sqlauthentication

[stevepiercy]

@pauleveritt there's some source code without a narrative write-up. What's the back story on this?
https://github.com/Pylons/pyramid_tutorials/tree/master/quick_traversal/sqlauthentication

What do you think should be done with it?

[pauleveritt]

That’s a good question. When I originally wrote that, I gave up on that section, as I was under a deadline. Since then, I’ve done the whole thing twice, once for O’Reilly and once for a hoped-for dedicated package:

https://github.com/pauleveritt/pyramid_sqltraversal

I’d be interested to hear your latest vision on pyramid_tutorials vs. cookbook. Then based on that, some choices:

1. Is this topic worth having in the “commons”? Or cookbook? Or separate package?

2. Does the topic deserve brief treatment, medium, or mega-full?

—Paul

On Dec 26, 2015, at 4:01 AM, Steve Piercy notifications@github.com wrote:

@pauleveritt https://github.com/pauleveritt there's some source code without a narrative write-up. What's the back story on this?
https://github.com/Pylons/pyramid_tutorials/tree/master/quick_traversal/sqlauthentication https://github.com/Pylons/pyramid_tutorials/tree/master/quick_traversal/sqlauthentication
What do you think should be done with it?

—
Reply to this email directly or view it on GitHub #123.

[stevepiercy]

1. Is this topic worth having in the “commons”? Or cookbook? Or separate package?
2. Does the topic deserve brief treatment, medium, or mega-full?

Well, the topic of the tutorial is not well-defined. Is it "traversal only" or "traversal with sqlalchemy"?

traversal only

• ZODB + Traversal Wiki Tutorial (Official)

traversal with sqlalchemy

• Quick Tutorial for Traversal (Pyramid Tutorials)
• Routing: Traversal and URL Dispatch (Pyramid Cookbook)

There is currently no traversal with sqlalchemy tutorial in official docs. If one were to be added, assuming all the content from the community-based Pyramid Tutorials and Pyramid Cookbook were merged into the official version, then we could kill off those two.

Long-term, trypyramid.com and the official docs would supersede this repo's usefulness, and it would just go away: trypyramid.com would be the signpost directing users to the various tutorials, and the official docs and Cookbook would hold the content.

Until trypyramid.com assumes that role, we can set up signposts in Pyramid Tutorials as we did for Humans and others.

• I'd be perfectly happy moving my PyCharm tutorial to the Cookbook (it should be there anyway).
• The single-file tasks tutorial would be an easy move to the Cookbook. It does not conform to how we want to promote Pyramid.
• That would leave just Quick Tutorial for Traversal as the lone tutorial in Pyramid Tutorials.

As far as the degree of treatment, the rule of thumb is to avoid duplication and provide reference to official docs.

[pauleveritt]

That “Quick Traversal” tutorial was an attempt to teach (evangelize?) the concept of traversal, starting with no persistence. Just gradually building up the concepts. First with in-memory pure Python. I then showed ZODB, then showed SQL.

I could rip out the ZODB one and focus on SQL traversal, but that would still leave out the most basic part (pure Python).

I’m -1 on extending the official docs with a SQL traversal. I’m ok with getting rid of “Quick Traversal” as the only thing left in Pyramid Tutorials, and re-casting it in Pyramid Cookbook.

—Paul

On Dec 28, 2015, at 4:05 PM, Steve Piercy notifications@github.com wrote:

1. Is this topic worth having in the “commons”? Or cookbook? Or separate package?
2. Does the topic deserve brief treatment, medium, or mega-full?

Well, the topic of the tutorial is not well-defined. Is it "traversal only" or "traversal with sqlalchemy"?

traversal only

ZODB + Traversal Wiki Tutorial http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki/index.html (Official)
traversal with sqlalchemy

Quick Tutorial for Traversal http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/quick_traversal/index.html (Pyramid Tutorials)
Routing: Traversal and URL Dispatch http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/routing/index.html (Pyramid Cookbook)
There is currently no traversal with sqlalchemy tutorial in official docs. If one were to be added, assuming all the content from the community-based Pyramid Tutorials and Pyramid Cookbook were merged into the official version, then we could kill off those two.

Long-term, trypyramid.com and the official docs would supersede this repo's usefulness, and it would just go away: trypyramid.com would be the signpost directing users to the various tutorials, and the official docs and Cookbook would hold the content.

Until trypyramid.com assumes that role, we can set up signposts in Pyramid Tutorials as we did for Humans and others.

I'd be perfectly happy moving my PyCharm tutorial to the Cookbook (it should be there anyway).
The single-file tasks tutorial would be an easy move to the Cookbook. It does not conform to how we want to promote Pyramid.
That would leave just Quick Tutorial for Traversal http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/quick_traversal/index.html as the lone tutorial in Pyramid Tutorials.
As far as the degree of treatment, the rule of thumb is to avoid duplication and provide reference to official docs.

—
Reply to this email directly or view it on GitHub #123 (comment).

[stevepiercy]

Excellent. I'll do the work here, in the Cookbook, and any other place where a specific tutorial in this repo is mentioned. One fewer repo to search for documentation will make me very happy, and provide a clear separation of official and community.

See also: Pylons/pyramid_cookbook#155