107 lines
2.5 KiB
ReStructuredText
107 lines
2.5 KiB
ReStructuredText
Welcome to *Kapow!*
|
|
===================
|
|
|
|
.. image:: https://circleci.com/gh/BBVA/kapow/tree/master.svg?style=svg
|
|
:target: https://circleci.com/gh/BBVA/kapow/tree/master
|
|
.. image:: https://goreportcard.com/badge/github.com/bbva/kapow
|
|
:target: https://goreportcard.com/report/github.com/bbva/kapow
|
|
.. image:: https://img.shields.io/github/issues/BBVA/kapow
|
|
:target: https://github.com/BBVA/kapow/issues/
|
|
.. image:: https://img.shields.io/github/v/release/BBVA/kapow?include_prereleases
|
|
:target: https://github.com/BBVA/kapow/releases
|
|
|
|
**If you can script it, you can HTTP it**
|
|
|
|
|
|
What's *Kapow!*
|
|
---------------
|
|
|
|
Think of that software that you need but **only runs in the command
|
|
line**. *Kapow!* lets you wrap it into an `HTTP API` **real easy**.
|
|
|
|
.. image:: _static/kapow-quick-overview.png
|
|
:width: 80%
|
|
:align: center
|
|
|
|
Want to know more?
|
|
Check the :ref:`Quick Start Guide <quickstart>` section for a longer
|
|
explanation of what *Kapow!* does.
|
|
|
|
|
|
Authors
|
|
-------
|
|
|
|
*Kapow!* is being developed by the `BBVA-Labs Security team`_.
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
*Kapow!* is Open Source Software and available under the `Apache 2 license`_.
|
|
|
|
|
|
Contributions
|
|
-------------
|
|
|
|
Contributions are of course welcome. See `CONTRIBUTING`_ or skim
|
|
`existing tickets`_ to see where you could help out.
|
|
|
|
|
|
Contents
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: The Project
|
|
|
|
the_project/quickstart
|
|
the_project/security
|
|
the_project/install_and_configure
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Tutorial
|
|
|
|
tutorial/index
|
|
tutorial/tutorial00
|
|
tutorial/tutorial01
|
|
tutorial/tutorial02
|
|
tutorial/tutorial03
|
|
tutorial/tutorial04
|
|
tutorial/tutorial05
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Usage Examples
|
|
|
|
examples/working_with_pow_files
|
|
examples/managing_routes
|
|
examples/handling_http_requests
|
|
examples/using_json
|
|
examples/shell_tricks
|
|
examples/using_reverse_proxies
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Concepts
|
|
|
|
concepts/interfaces
|
|
concepts/philosophy
|
|
concepts/request_life_cycle
|
|
concepts/resource_tree
|
|
concepts/route_matching
|
|
concepts/routes
|
|
|
|
Indices and Tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. _BBVA-Labs Security team: https://github.com/BBVA/kapow/blob/master/AUTHORS.rst
|
|
.. _Apache 2 license: https://raw.githubusercontent.com/BBVA/kapow/master/LICENSE
|
|
.. _CONTRIBUTING: https://github.com/BBVA/kapow/blob/master/CONTRIBUTING.rst
|
|
.. _existing tickets: https://github.com/BBVA/kapow/labels/good%20first%20issue
|