diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:26:15 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:26:15 +0000 |
| commit | b5b1207c574113f4045fcea975d0bfc013aeea22 (patch) | |
| tree | cea06981f847b99aaa320d73c3b00c26b11b39fd /python-flask-autodoc.spec | |
| parent | ad543e1c812fac095ff3b4f2ef2b3cd3fb3afec9 (diff) | |
automatic import of python-flask-autodoc
Diffstat (limited to 'python-flask-autodoc.spec')
| -rw-r--r-- | python-flask-autodoc.spec | 300 |
1 files changed, 300 insertions, 0 deletions
diff --git a/python-flask-autodoc.spec b/python-flask-autodoc.spec new file mode 100644 index 0000000..f58b058 --- /dev/null +++ b/python-flask-autodoc.spec @@ -0,0 +1,300 @@ +%global _empty_manifest_terminate_build 0 +Name: python-Flask-Autodoc +Version: 0.1.2 +Release: 1 +Summary: Documentation generator for flask +License: MIT +URL: http://github.com/acoomans/flask-autodoc +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ec/fd/cba920b70474b236e6033adcd979d04db221b7278cb7c442a867b669596d/Flask-Autodoc-0.1.2.tar.gz +BuildArch: noarch + + +%description +Flask-Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. +[](https://travis-ci.org/acoomans/flask-autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) + + +## Requirements +Flask-Autodoc is compatible with Python versions 2 and 3; and it depends only on Flask. +## Install +To install Flask-Autodoc, run pip: + pip install flask-autodoc +or clone this directory and run setup: + python setup.py install +## Usage +Start using Flask-Autodoc by importing it and initializing it: + from flask import Flask + from flask.ext.autodoc import Autodoc + app = Flask(__name__) + auto = Autodoc(app) +by default, Flask-Autodoc will only document the routes explicitly decorated with _doc_: + @app.route('/user/<int:id>') + @auto.doc() + def show_user(id): + return user_from_database(id) +to generate the documentation, use the _html()_ method: + @app.route('/documentation') + def documentation(): + return auto.html() +## Custom documentation +To access the documentation without rendering html: + @app.route('/documentation') + def documentation(): + return auto.generate() +the documentation will be returned as a list of rules, where each rule is a dictionary containing: +- methods: the set of allowed methods (ie ['GET', 'POST']) +- rule: relative url (ie '/user/<int:id>') +- endpoint: function name (ie 'show_user') +- doc: docstring of the function +- args: function arguments +- defaults: defaults values for the arguments +## Custom template +To use a custom template for your documentation, give a _template_ argument to the _html_ method. This will use a template from the flask _templates_ directory. +Additionnal arguments (other than _group_, _groups_, and _template_) will be passed down to the template: + auto.html( + template='custom_documentation.html' + title='My Documentation', + author='John Doe', + ) +_title_ and _author_ will be available in the template: + <!-- templates/custom_documentation.html --> + {% if title is defined %} + {{title}} + {% endif %} +## Documentation sets +Endpoints can be grouped together in different documentation sets. It is possible for instance to show some endpoints to third party developers and have full documentation for primary developers. +To assign an endpoint to a group, pass the name of the group as argument of the _doc_ decorator: + @app.route('/user/<int:id>') + @auto.doc('public') + def show_user(id): +to assign an endpoint to multiple groups, pass a list of group names as the _groups_ argument to _doc_: + @app.route('/user/<int:id>') + @auto.doc(groups=['public','private']) + def show_user(id): +to generate the documentation for a specific group, pass the name of the group to the _html_ or _generate_ methods: + auto.html('public') + auto.html(groups=['public','private']) + auto.generate('public') +## Examples +Apps in the _examples_ directory are an api for a blog: +- _simple_ is a simple app +- _factory_ uses blueprints +Run with + python simple/blog.py +and connect to [/doc/public](http://127.0.0.1:5000/doc/public) and [/doc/private](http://127.0.0.1:5000/doc/private) to see public and private documentations. +## Screenshots + + + +%package -n python3-Flask-Autodoc +Summary: Documentation generator for flask +Provides: python-Flask-Autodoc +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-Flask-Autodoc +Flask-Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. +[](https://travis-ci.org/acoomans/flask-autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) + + +## Requirements +Flask-Autodoc is compatible with Python versions 2 and 3; and it depends only on Flask. +## Install +To install Flask-Autodoc, run pip: + pip install flask-autodoc +or clone this directory and run setup: + python setup.py install +## Usage +Start using Flask-Autodoc by importing it and initializing it: + from flask import Flask + from flask.ext.autodoc import Autodoc + app = Flask(__name__) + auto = Autodoc(app) +by default, Flask-Autodoc will only document the routes explicitly decorated with _doc_: + @app.route('/user/<int:id>') + @auto.doc() + def show_user(id): + return user_from_database(id) +to generate the documentation, use the _html()_ method: + @app.route('/documentation') + def documentation(): + return auto.html() +## Custom documentation +To access the documentation without rendering html: + @app.route('/documentation') + def documentation(): + return auto.generate() +the documentation will be returned as a list of rules, where each rule is a dictionary containing: +- methods: the set of allowed methods (ie ['GET', 'POST']) +- rule: relative url (ie '/user/<int:id>') +- endpoint: function name (ie 'show_user') +- doc: docstring of the function +- args: function arguments +- defaults: defaults values for the arguments +## Custom template +To use a custom template for your documentation, give a _template_ argument to the _html_ method. This will use a template from the flask _templates_ directory. +Additionnal arguments (other than _group_, _groups_, and _template_) will be passed down to the template: + auto.html( + template='custom_documentation.html' + title='My Documentation', + author='John Doe', + ) +_title_ and _author_ will be available in the template: + <!-- templates/custom_documentation.html --> + {% if title is defined %} + {{title}} + {% endif %} +## Documentation sets +Endpoints can be grouped together in different documentation sets. It is possible for instance to show some endpoints to third party developers and have full documentation for primary developers. +To assign an endpoint to a group, pass the name of the group as argument of the _doc_ decorator: + @app.route('/user/<int:id>') + @auto.doc('public') + def show_user(id): +to assign an endpoint to multiple groups, pass a list of group names as the _groups_ argument to _doc_: + @app.route('/user/<int:id>') + @auto.doc(groups=['public','private']) + def show_user(id): +to generate the documentation for a specific group, pass the name of the group to the _html_ or _generate_ methods: + auto.html('public') + auto.html(groups=['public','private']) + auto.generate('public') +## Examples +Apps in the _examples_ directory are an api for a blog: +- _simple_ is a simple app +- _factory_ uses blueprints +Run with + python simple/blog.py +and connect to [/doc/public](http://127.0.0.1:5000/doc/public) and [/doc/private](http://127.0.0.1:5000/doc/private) to see public and private documentations. +## Screenshots + + + +%package help +Summary: Development documents and examples for Flask-Autodoc +Provides: python3-Flask-Autodoc-doc +%description help +Flask-Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. +[](https://travis-ci.org/acoomans/flask-autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) +[](https://pypi.python.org/pypi/Flask-Autodoc) + + +## Requirements +Flask-Autodoc is compatible with Python versions 2 and 3; and it depends only on Flask. +## Install +To install Flask-Autodoc, run pip: + pip install flask-autodoc +or clone this directory and run setup: + python setup.py install +## Usage +Start using Flask-Autodoc by importing it and initializing it: + from flask import Flask + from flask.ext.autodoc import Autodoc + app = Flask(__name__) + auto = Autodoc(app) +by default, Flask-Autodoc will only document the routes explicitly decorated with _doc_: + @app.route('/user/<int:id>') + @auto.doc() + def show_user(id): + return user_from_database(id) +to generate the documentation, use the _html()_ method: + @app.route('/documentation') + def documentation(): + return auto.html() +## Custom documentation +To access the documentation without rendering html: + @app.route('/documentation') + def documentation(): + return auto.generate() +the documentation will be returned as a list of rules, where each rule is a dictionary containing: +- methods: the set of allowed methods (ie ['GET', 'POST']) +- rule: relative url (ie '/user/<int:id>') +- endpoint: function name (ie 'show_user') +- doc: docstring of the function +- args: function arguments +- defaults: defaults values for the arguments +## Custom template +To use a custom template for your documentation, give a _template_ argument to the _html_ method. This will use a template from the flask _templates_ directory. +Additionnal arguments (other than _group_, _groups_, and _template_) will be passed down to the template: + auto.html( + template='custom_documentation.html' + title='My Documentation', + author='John Doe', + ) +_title_ and _author_ will be available in the template: + <!-- templates/custom_documentation.html --> + {% if title is defined %} + {{title}} + {% endif %} +## Documentation sets +Endpoints can be grouped together in different documentation sets. It is possible for instance to show some endpoints to third party developers and have full documentation for primary developers. +To assign an endpoint to a group, pass the name of the group as argument of the _doc_ decorator: + @app.route('/user/<int:id>') + @auto.doc('public') + def show_user(id): +to assign an endpoint to multiple groups, pass a list of group names as the _groups_ argument to _doc_: + @app.route('/user/<int:id>') + @auto.doc(groups=['public','private']) + def show_user(id): +to generate the documentation for a specific group, pass the name of the group to the _html_ or _generate_ methods: + auto.html('public') + auto.html(groups=['public','private']) + auto.generate('public') +## Examples +Apps in the _examples_ directory are an api for a blog: +- _simple_ is a simple app +- _factory_ uses blueprints +Run with + python simple/blog.py +and connect to [/doc/public](http://127.0.0.1:5000/doc/public) and [/doc/private](http://127.0.0.1:5000/doc/private) to see public and private documentations. +## Screenshots + + + +%prep +%autosetup -n Flask-Autodoc-0.1.2 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-Flask-Autodoc -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.2-1 +- Package Spec generated |