Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mstuttgart/flask-pycharm-templates

Collection of Pycharm IDE snippets to Flask framework
https://github.com/mstuttgart/flask-pycharm-templates

flask pycharm-ide python snippets tools

Last synced: about 1 month ago
JSON representation

Collection of Pycharm IDE snippets to Flask framework

Awesome Lists containing this project

README

        

# Flask PyCharm Templates

Collection of Jetbrains PyCharm IDE templates to help you develop Flask web applications.

## Features

All `PyCharm Flask` code snippets start with the `f` letter.

### Python snippets

| Abbreviation | Description |
|--------------|--------------------------------|
| """ | ML docstring |
| "" | SL docstring |
| fapp | Flask App |
| froute | Flask route |
| furl | URL generator |
| fmeth | URL methods |
| frt | Render template |
| ftreq | Test request |
| fup | Flask upload |
| fsup | Secure upload |
| frc | Read cookie |
| fsc | Set cookie |
| feh | Error handler |
| flog | Flask logging |
| fflash | Flash message |
| fflashcateg | Flash message with category |
| fflashfilter | Flash message with filter |

### Flask Jinja2 template snippets

| Abbreviation | Description |
|--------------|--------------------------------|
| fexp | Flask Jinja2 expression tag |
| ffilter | Flask Jinja2 filter tag |
| fcomment | Flask Jinja2 comment tag |
| fblock | Flask Jinja2 block |
| fextends | Flask Jinja2 extends tag |
| fself | Flask Jinja2 self tag |
| fsuper | Flask Jinja2 super tag |
| ffor | Flask Jinja2 for tag |
| fif | Flask Jinja2 if block |
| fife | Flask Jinja2 if-else block |
| felif | Flask Jinja2 elif block |
| fmacro | Flask Jinja2 macro tag |
| ffb | Flask Jinja2 filter block |
| fset | Flask Jinja2 set tag |
| finclude | Flask Jinja2 include tag |
| fimport | Flask Jinja2 import tag |
| fautoescape | Flask Jinja2 autoescape tag |
| furl | Flask Jinja2 url_for tag |

## Installation

1. Download `settings.jar` file: [click here](https://github.com/mstuttgart/flask-pycharm-templates/raw/master/settings.jar)

1. Go to `File | Import Settings...` in PyCharm IDE and select the downloaded `settings.jar` file. Click `OK` in the dialog that appears.

2. Restart `PyCharmIDE`: Go to `File | Invalidate Chaches / Restart...` menu, and click in `Just Restart` button. The PyCharm IDE will be restart.

3. Enjoy with Flask templates!

## Contributing

If you'd like to contribute, please create a fork and open issue or pull requests! I am very open to newcomers, and will need all the help we can get to make the best flask snippets to PyCharm IDE.

To create new snippets, download and install the `settings.jar` file. Go to `File | Settings | Editor | Live Templates`, select `Flask` and add your new snippets.

## Credits

This project (Flask API snippets and Jinja2 snippets) is fully based on snippets created by [jleonra](https://github.com/jleonra/flask-snippets).

Copyright (c) 2017 Michell Stuttgart