Metadata-Version: 2.4
Name: vim_flask_tools
Version: 0.0.2
Summary: Dump code navigation information for a flask project to use in Vim
License-File: LICENSE
Author: Andrew Radev
Author-email: andrey.radev@gmail.com
Requires-Python: >=3.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: flask (>=3.0)
Project-URL: Repository, https://codeberg.org/AndrewRadev/vim_flask_tools.py
Description-Content-Type: text/markdown

This project provides a simple function, `dump_metadata`, which takes a flask app and writes a JSON file with information about the app, including the `template_folder` and `static_folder` settings, and a dictionary of all routes defined in the application. Basic usage:

```python
from flask import Flask
from vim_flask_tools import dump_metadata

app = Flask(__name__)

dump_metadata(app, project_file='.flask_tools.json')
```

By default, the second argument is not necessary, but could be used to customize the config file's name. Ideally, the function should be called only in development mode, when it would be called every time the app is restarted.

This file is indented to be used with [flask_tools.vim](https://codeberg.org/AndrewRadev/flask_tools.vim), though technically, nothing is stopping you from using this metadata with your own custom tool if you'd like.

