search

skariel / webalchemy

Modern web development with Python
MIT License
346 stars 21 forks source link

Update README.md, fix typos, add stylesheet example #135

Closed joaoventura closed 10 years ago

joaoventura commented 10 years ago

Fixed some typos in README.txt, added some punctuation and a stylesheet example.

skariel commented 10 years ago

it's starting to look like a documentation. Some sections I think are important:

joaoventura commented 10 years ago

I would also add a good "Getting started", although the Hello World example is very good. Things like accessing javascript functions on the client side are also pretty important, because people expect to continue using javascript frameworks (like jquery, etc.).

One thing that I wanted when I was searching for python client frameworks was if there was UI widgets already usable. Do you think that it can be a great selling point something like the jquery mobile example (or maybe a tutorial)? Or maybe some wrapper in a /Lib which would allow for non-web python programmers to more easily use webalchemy. I cannot stress how important is a UI toolkit for non-web python programmers (as I am).

I think in the future, there should be documentation specifically for the people who want to contribute to the project. Although now it is somewhat small, and you can read the source-code easily, in the future it can get harder to understand. Things like the "boring" details of the read-eval loop would be in that section.

I would also like to ask if it was possible to start commenting the source code? Although Python, as language, is very readable, commenting the working of some blocks of code would allow for more developers to understand more easily the source code. It is very important for a open-source project to have the source code commented, and it reduces future errors. You, as commiter, would have to ask for people for readable source code and meaningful comments.

Finally, is it possible to create a github web site? Github makes possible to create web sites and documentation and tutorials could be more detailed there..

skariel commented 10 years ago

hi, I did a few changes, the colors example is now live at Heroku here I plan to write a tutorial on how to do this.

About widgets - they are very important, there's even a widgets sub-package in webalchemy currently hosting just a menu and a table and both with little to no functionality. The long term plan is to have a rich widgets library inside webalchemy. In the meanwhile of course a tutorial/demo/example on jquery mobile would be a great selling point!

I agree about the comments, it's high time to start with them.

About a github website - there is currently one (see the github-pages branch) but I took it off of all the links since it had no additional value over the main github repo. But there is no problem renovating it...

Iftahh commented 10 years ago

For widgets I'd suggest taking an existing framework such as the excellent and super popular "Bootstrap" (http://getbootstrap.com/) and wrap its widgets in WebAlchemy API (eg. the javascript events of the widgets will trigger web-alchemy python callbacks if wired up). No need re-inventing the wheel of html+css+javascript widgets.

On Mon, Jan 27, 2014 at 4:59 PM, Ariel Keselman notifications@github.comwrote:

hi, I did a few changes, the colors example is now live at Heroku herehttp://fast-ravine-4935.herokuapp.com/I plan to write a tutorial on how to do this.

About widgets - they are very important, there's even a widgets sub-package in webalchemy currently hosting just a menu and a table and both with little to no functionality. The long term plan is to have a rich widgets library inside webalchemy. In the meanwhile of course a tutorial/demo/example on jquery mobile would be a great selling point!

I agree about the comments, it's high time to start with them.

About a github website - there is currently one (see the github-pages branch) but I took it off of all the links since it had no additional value over the main github repo. But there is no problem renovating it...

— Reply to this email directly or view it on GitHubhttps://github.com/skariel/webalchemy/pull/135#issuecomment-33374254 .

skariel commented 10 years ago

just implemented heartbeats (upstream, downstream, jitter) so no more disconnections at heroku

jcrubino commented 10 years ago

For widgets I'd like to nominate semantic ui http://semantic-ui.com/ or gumby UI http://gumbyframework.com/docs/ui-kit/ for consideration.

On Mon, Jan 27, 2014 at 1:06 PM, Ariel Keselman notifications@github.comwrote:

just implemented heartbeats (upstream, downstream, jitter) so no more disconnections at heroku

— Reply to this email directly or view it on GitHubhttps://github.com/skariel/webalchemy/pull/135#issuecomment-33408898 .

skariel commented 10 years ago

just an update on the heroku app- it was exploding in memory and crashed the browser tab. Now this is really fixed (hopefully. I'll let it run all night)

joaoventura commented 10 years ago

Hi there skariel,

did the server managed to work all night without going down? I've tested just some hours ago and the demo was running..

skariel commented 10 years ago

Yes, it is ok now. But I still see some disconnections on the ipad When switching tabs. I think unused tabs in safari are shut down, and the same goes when Safari runs in the background. But I'm not sure. Anyway, I intent to implement silent reconnections which should fix this