Metadata-Version: 2.4
Name: trytond_web_shortener
Version: 8.0.0
Summary: URL shortener for Tryton
Project-URL: homepage, https://www.tryton.org/
Project-URL: documentation, https://docs.tryton.org/modules-web-shortener/
Project-URL: changelog, https://docs.tryton.org/modules-web-shortener/releases.html
Project-URL: forum, https://www.tryton.org/forum
Project-URL: issues, https://bugs.tryton.org/tryton
Project-URL: repository, https://code.tryton.org/tryton
Project-URL: funding, https://www.tryton.org/donate
Author: B2CK SRL
Author-email: Cédric Krier <cedric.krier@b2ck.com>, Nicolas Êvrard <nicolas.evrard@b2ck.com>
Maintainer-email: Tryton <foundation@tryton.org>
License-Expression: GPL-3.0-or-later
License-File: COPYRIGHT
License-File: LICENSE
Keywords: tryton
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Tryton
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: python-sql
Requires-Dist: trytond<8.1,>=8.0
Provides-Extra: test
Description-Content-Type: text/x-rst

Web Shortener Module
####################

The web_shortener module allows URLs to be shortened. It counts the number of
times the URL is accessed and optionally triggers action.

The module defines a route ``/s/<shortened_id>``
which will redirect the queries to the URL registered previously with
``ShortenedURL.get_url``.

Models that need to be callable from a shortened URL must define the method
``shortened_url_execute``. This class method will be called from the underlying
queue with the record and the keywords arguments transmitted when calling
``get_url``.

Shortened URL
*************

- Shortened URL: The shortened URL
- Redirect URL: The URL the request is redirected to
- Record: The record on which ``method`` will be executed
- Method: The name of the method to call on ``record``
- Count: The number of times this shortened URL has been triggered

Configuration
*************

The web_shortener modules uses the parameter from the section:

- ``[web]``:

    - ``shortener_base``: The base URL without path for shortened URL.
      The default value is composed with the configuration ``[web]``
      ``hostname``.
