librelist archives

« back to archive

Show Flask: Grip

Show Flask: Grip

From:
Joe Esposito
Date:
2012-11-19 @ 14:16
Hey all,

I wrote a simple tool over the weekend that uses Flask to render a Github
Readme file before you commit and push to Github.
Not much to it. It uses Github's Markdown Rendering API for the actual
rendering and their style sheets, so you know it'll look right.

To try it out:

$ pip install grip
$ cd my-project
$ grip


It's been quite helpful for me already, so thought I'd share it with you.

https://github.com/joeyespo/grip

-Joe

Re: [flask] Show Flask: Grip

From:
David Baumgold
Date:
2012-11-19 @ 14:31
Joe: Github publicly states[1] that they use the Sundown library to render
Markdown, via the Ruby bindings (Redcarpet). There is also a set of Python
bindings to Sundown, called Misaka [2]. I recently wrote a Flask extension
to integrate Misaka into Flask, and I am seeking feedback on it: the 
extension is called Flask-Misaka (appropriately enough) and you can 
install it from Github [3] or via PyPI [4]. You may want to add an option 
go your `grip` tool to use Flask-Misaka instead of making a request to the
Markdown Rendering API; that way, you can use `grip` offline, and it will 
be faster.

If you have any feedback on Flask-Misaka, please let me know!
-David

[1] http://github.github.com/github-flavored-markdown/
[2] https://github.com/FSX/misaka
[3] https://github.com/singingwolfboy/Flask-Misaka
[4] http://pypi.python.org/pypi/Flask-Misaka



On Monday, November 19, 2012 at 9:16 AM, Joe Esposito wrote:

> Hey all,
> 
> I wrote a simple tool over the weekend that uses Flask to render a 
Github Readme file before you commit and push to Github.
> Not much to it. It uses Github's Markdown Rendering API for the actual 
rendering and their style sheets, so you know it'll look right.
> 
> To try it out:
> 
> > $ pip install grip
> > $ cd my-project
> > 
> > $ grip
> 
> 
> It's been quite helpful for me already, so thought I'd share it with you.
> 
> https://github.com/joeyespo/grip 
> 
> -Joe 

Re: [flask] Show Flask: Grip

From:
Joe Esposito
Date:
2012-11-19 @ 17:42
@Freedom

> *Hey that's pretty handy!*
Thanks =)

> *You might consider running it on a different port than Flask's default
port*
Yes, I usually do this locally by adding a local_config.py file to override
the default settings.
I want to add command-line arguments eventually. Something like grip -a
[host][:port] <filename> in case you want to render something other than
the readme. I'll push something out in the next few days.

Thanks for the feedback!

@David

Thanks for the links! I did investigate this, but I wanted to ship an MVP
quickly so I could move on and actually use it.
I do think offline rendering is ultimately the direction it should go. When
I get there, I'll check out your extension =)

I might even delegate the rendering to the browser and have the Flask
server merely watch the file for changes and push out new content without
requiring a full browser refresh.
Similar to this site <http://tmpvar.com/markdown.html>, which is what I
used before, but got tired of copying/pasting to see my Readme updates.
This would make sense for, say, a Sublime Text plugin, which is ultimately
something I intend to use this with.

Thanks for the feedback =)
-Joe

On Mon, Nov 19, 2012 at 9:31 AM, David Baumgold <david@davidbaumgold.com>wrote:

> Joe: Github publicly states[1] that they use the Sundown library to render
> Markdown, via the Ruby bindings (Redcarpet). There is also a set of Python
> bindings to Sundown, called Misaka [2]. I recently wrote a Flask extension
> to integrate Misaka into Flask, and I am seeking feedback on it: the
> extension is called Flask-Misaka (appropriately enough) and you can install
> it from Github [3] or via PyPI [4]. You may want to add an option go your
> `grip` tool to use Flask-Misaka instead of making a request to the Markdown
> Rendering API; that way, you can use `grip` offline, and it will be faster.
>
> If you have any feedback on Flask-Misaka, please let me know!
> -David
>
> [1] http://github.github.com/github-flavored-markdown/
> [2] https://github.com/FSX/misaka
> [3] https://github.com/singingwolfboy/Flask-Misaka
> [4] http://pypi.python.org/pypi/Flask-Misaka
>
>
>
> On Monday, November 19, 2012 at 9:16 AM, Joe Esposito wrote:
>
> > Hey all,
> >
> > I wrote a simple tool over the weekend that uses Flask to render a
> Github Readme file before you commit and push to Github.
> > Not much to it. It uses Github's Markdown Rendering API for the actual
> rendering and their style sheets, so you know it'll look right.
> >
> > To try it out:
> >
> > > $ pip install grip
> > > $ cd my-project
> > >
> > > $ grip
> >
> >
> > It's been quite helpful for me already, so thought I'd share it with you.
> >
> > https://github.com/joeyespo/grip
> >
> > -Joe
>
>
>

Re: [flask] Show Flask: Grip

From:
Joe Esposito
Date:
2012-11-19 @ 18:37
@Freedom I added an issue to change the port via the command line:
https://github.com/joeyespo/grip/issues/3

@David I added an issue involving your extension:
https://github.com/joeyespo/grip/issues/4

Of course, I'll assign myself to an issue before I actually begin working
on it.

On Mon, Nov 19, 2012 at 12:42 PM, Joe Esposito <espo58@gmail.com> wrote:

> @Freedom
>
> > *Hey that's pretty handy!*
> Thanks =)
>
> > *You might consider running it on a different port than Flask's default
> port*
> Yes, I usually do this locally by adding a local_config.py file to
> override the default settings.
> I want to add command-line arguments eventually. Something like grip -a
> [host][:port] <filename> in case you want to render something other than
> the readme. I'll push something out in the next few days.
>
> Thanks for the feedback!
>
> @David
>
> Thanks for the links! I did investigate this, but I wanted to ship an MVP
> quickly so I could move on and actually use it.
> I do think offline rendering is ultimately the direction it should go. When
> I get there, I'll check out your extension =)
>
> I might even delegate the rendering to the browser and have the Flask
> server merely watch the file for changes and push out new content without
> requiring a full browser refresh.
> Similar to this site <http://tmpvar.com/markdown.html>, which is what I
> used before, but got tired of copying/pasting to see my Readme updates.
> This would make sense for, say, a Sublime Text plugin, which is ultimately
> something I intend to use this with.
>
> Thanks for the feedback =)
> -Joe
>
> On Mon, Nov 19, 2012 at 9:31 AM, David Baumgold <david@davidbaumgold.com>wrote:
>
>> Joe: Github publicly states[1] that they use the Sundown library to
>> render Markdown, via the Ruby bindings (Redcarpet). There is also a set of
>> Python bindings to Sundown, called Misaka [2]. I recently wrote a Flask
>> extension to integrate Misaka into Flask, and I am seeking feedback on it:
>> the extension is called Flask-Misaka (appropriately enough) and you can
>> install it from Github [3] or via PyPI [4]. You may want to add an option
>> go your `grip` tool to use Flask-Misaka instead of making a request to the
>> Markdown Rendering API; that way, you can use `grip` offline, and it will
>> be faster.
>>
>> If you have any feedback on Flask-Misaka, please let me know!
>> -David
>>
>> [1] http://github.github.com/github-flavored-markdown/
>> [2] https://github.com/FSX/misaka
>> [3] https://github.com/singingwolfboy/Flask-Misaka
>> [4] http://pypi.python.org/pypi/Flask-Misaka
>>
>>
>>
>> On Monday, November 19, 2012 at 9:16 AM, Joe Esposito wrote:
>>
>> > Hey all,
>> >
>> > I wrote a simple tool over the weekend that uses Flask to render a
>> Github Readme file before you commit and push to Github.
>> > Not much to it. It uses Github's Markdown Rendering API for the actual
>> rendering and their style sheets, so you know it'll look right.
>> >
>> > To try it out:
>> >
>> > > $ pip install grip
>> > > $ cd my-project
>> > >
>> > > $ grip
>> >
>> >
>> > It's been quite helpful for me already, so thought I'd share it with
>> you.
>> >
>> > https://github.com/joeyespo/grip
>> >
>> > -Joe
>>
>>
>>
>

Re: [flask] Show Flask: Grip

From:
Joe Esposito
Date:
2012-11-21 @ 05:03
FYI you can now render a README with Grip on *any port*.

    $ grip 8080

Thanks for the suggestion, Freedom!

https://github.com/joeyespo/grip

On Mon, Nov 19, 2012 at 1:37 PM, Joe Esposito <espo58@gmail.com> wrote:

> @Freedom I added an issue to change the port via the command line:
> https://github.com/joeyespo/grip/issues/3
>
> @David I added an issue involving your extension:
> https://github.com/joeyespo/grip/issues/4
>
> Of course, I'll assign myself to an issue before I actually begin working
> on it.
>
>
> On Mon, Nov 19, 2012 at 12:42 PM, Joe Esposito <espo58@gmail.com> wrote:
>
>> @Freedom
>>
>> > *Hey that's pretty handy!*
>> Thanks =)
>>
>> > *You might consider running it on a different port than Flask's
>> default port*
>> Yes, I usually do this locally by adding a local_config.py file to
>> override the default settings.
>> I want to add command-line arguments eventually. Something like grip -a
>> [host][:port] <filename> in case you want to render something other than
>> the readme. I'll push something out in the next few days.
>>
>> Thanks for the feedback!
>>
>> @David
>>
>> Thanks for the links! I did investigate this, but I wanted to ship an MVP
>> quickly so I could move on and actually use it.
>> I do think offline rendering is ultimately the direction it should go. When
>> I get there, I'll check out your extension =)
>>
>> I might even delegate the rendering to the browser and have the Flask
>> server merely watch the file for changes and push out new content without
>> requiring a full browser refresh.
>> Similar to this site <http://tmpvar.com/markdown.html>, which is what I
>> used before, but got tired of copying/pasting to see my Readme updates.
>> This would make sense for, say, a Sublime Text plugin, which is ultimately
>> something I intend to use this with.
>>
>> Thanks for the feedback =)
>> -Joe
>>
>> On Mon, Nov 19, 2012 at 9:31 AM, David Baumgold <david@davidbaumgold.com>wrote:
>>
>>> Joe: Github publicly states[1] that they use the Sundown library to
>>> render Markdown, via the Ruby bindings (Redcarpet). There is also a set of
>>> Python bindings to Sundown, called Misaka [2]. I recently wrote a Flask
>>> extension to integrate Misaka into Flask, and I am seeking feedback on it:
>>> the extension is called Flask-Misaka (appropriately enough) and you can
>>> install it from Github [3] or via PyPI [4]. You may want to add an option
>>> go your `grip` tool to use Flask-Misaka instead of making a request to the
>>> Markdown Rendering API; that way, you can use `grip` offline, and it will
>>> be faster.
>>>
>>> If you have any feedback on Flask-Misaka, please let me know!
>>> -David
>>>
>>> [1] http://github.github.com/github-flavored-markdown/
>>> [2] https://github.com/FSX/misaka
>>> [3] https://github.com/singingwolfboy/Flask-Misaka
>>> [4] http://pypi.python.org/pypi/Flask-Misaka
>>>
>>>
>>>
>>> On Monday, November 19, 2012 at 9:16 AM, Joe Esposito wrote:
>>>
>>> > Hey all,
>>> >
>>> > I wrote a simple tool over the weekend that uses Flask to render a
>>> Github Readme file before you commit and push to Github.
>>> > Not much to it. It uses Github's Markdown Rendering API for the actual
>>> rendering and their style sheets, so you know it'll look right.
>>> >
>>> > To try it out:
>>> >
>>> > > $ pip install grip
>>> > > $ cd my-project
>>> > >
>>> > > $ grip
>>> >
>>> >
>>> > It's been quite helpful for me already, so thought I'd share it with
>>> you.
>>> >
>>> > https://github.com/joeyespo/grip
>>> >
>>> > -Joe
>>>
>>>
>>>
>>
>

Re: [flask] Show Flask: Grip

From:
Freedom Dumlao
Date:
2012-11-21 @ 14:03
Awesome Joe! I like the simplicity of the argument.


On Wed, Nov 21, 2012 at 12:03 AM, Joe Esposito <espo58@gmail.com> wrote:

> FYI you can now render a README with Grip on *any port*.
>
>     $ grip 8080
>
> Thanks for the suggestion, Freedom!
>
> https://github.com/joeyespo/grip
>
> On Mon, Nov 19, 2012 at 1:37 PM, Joe Esposito <espo58@gmail.com> wrote:
>
>> @Freedom I added an issue to change the port via the command line:
>> https://github.com/joeyespo/grip/issues/3
>>
>> @David I added an issue involving your extension:
>> https://github.com/joeyespo/grip/issues/4
>>
>> Of course, I'll assign myself to an issue before I actually begin working
>> on it.
>>
>>
>> On Mon, Nov 19, 2012 at 12:42 PM, Joe Esposito <espo58@gmail.com> wrote:
>>
>>> @Freedom
>>>
>>> > *Hey that's pretty handy!*
>>> Thanks =)
>>>
>>> > *You might consider running it on a different port than Flask's
>>> default port*
>>> Yes, I usually do this locally by adding a local_config.py file to
>>> override the default settings.
>>> I want to add command-line arguments eventually. Something like grip -a
>>> [host][:port] <filename> in case you want to render something other than
>>> the readme. I'll push something out in the next few days.
>>>
>>> Thanks for the feedback!
>>>
>>> @David
>>>
>>> Thanks for the links! I did investigate this, but I wanted to ship an
>>> MVP quickly so I could move on and actually use it.
>>> I do think offline rendering is ultimately the direction it should go. When
>>> I get there, I'll check out your extension =)
>>>
>>> I might even delegate the rendering to the browser and have the Flask
>>> server merely watch the file for changes and push out new content without
>>> requiring a full browser refresh.
>>> Similar to this site <http://tmpvar.com/markdown.html>, which is what I
>>> used before, but got tired of copying/pasting to see my Readme updates.
>>> This would make sense for, say, a Sublime Text plugin, which is ultimately
>>> something I intend to use this with.
>>>
>>> Thanks for the feedback =)
>>> -Joe
>>>
>>> On Mon, Nov 19, 2012 at 9:31 AM, David Baumgold <david@davidbaumgold.com
>>> > wrote:
>>>
>>>> Joe: Github publicly states[1] that they use the Sundown library to
>>>> render Markdown, via the Ruby bindings (Redcarpet). There is also a set of
>>>> Python bindings to Sundown, called Misaka [2]. I recently wrote a Flask
>>>> extension to integrate Misaka into Flask, and I am seeking feedback on it:
>>>> the extension is called Flask-Misaka (appropriately enough) and you can
>>>> install it from Github [3] or via PyPI [4]. You may want to add an option
>>>> go your `grip` tool to use Flask-Misaka instead of making a request to the
>>>> Markdown Rendering API; that way, you can use `grip` offline, and it will
>>>> be faster.
>>>>
>>>> If you have any feedback on Flask-Misaka, please let me know!
>>>> -David
>>>>
>>>> [1] http://github.github.com/github-flavored-markdown/
>>>> [2] https://github.com/FSX/misaka
>>>> [3] https://github.com/singingwolfboy/Flask-Misaka
>>>> [4] http://pypi.python.org/pypi/Flask-Misaka
>>>>
>>>>
>>>>
>>>> On Monday, November 19, 2012 at 9:16 AM, Joe Esposito wrote:
>>>>
>>>> > Hey all,
>>>> >
>>>> > I wrote a simple tool over the weekend that uses Flask to render a
>>>> Github Readme file before you commit and push to Github.
>>>> > Not much to it. It uses Github's Markdown Rendering API for the
>>>> actual rendering and their style sheets, so you know it'll look right.
>>>> >
>>>> > To try it out:
>>>> >
>>>> > > $ pip install grip
>>>> > > $ cd my-project
>>>> > >
>>>> > > $ grip
>>>> >
>>>> >
>>>> > It's been quite helpful for me already, so thought I'd share it with
>>>> you.
>>>> >
>>>> > https://github.com/joeyespo/grip
>>>> >
>>>> > -Joe
>>>>
>>>>
>>>>
>>>
>>
>

Re: [flask] Show Flask: Grip

From:
Freedom Dumlao
Date:
2012-11-19 @ 14:29
Hey that's pretty handy!

One bit of feedback: You might consider running it on a different port than
Flask's default port. Like myself many developers may already have a Flask
application running on that port at the time of running grip.

- Freedom


On Mon, Nov 19, 2012 at 9:16 AM, Joe Esposito <espo58@gmail.com> wrote:

> Hey all,
>
> I wrote a simple tool over the weekend that uses Flask to render a Github
> Readme file before you commit and push to Github.
> Not much to it. It uses Github's Markdown Rendering API for the actual
> rendering and their style sheets, so you know it'll look right.
>
> To try it out:
>
> $ pip install grip
> $ cd my-project
> $ grip
>
>
> It's been quite helpful for me already, so thought I'd share it with you.
>
> https://github.com/joeyespo/grip
>
> -Joe
>
>