semvec/pypi-packages huggingface dataset:
guillotina-swagger 1.0.14
Swagger integration for viewing REST on your guillotina install
License: BSD
Keywords: guillotina,REST,swagger

Introduction
============

A `guillotina` application to automatically generate swagger interfaces for
APIs defined with `guillotina`.


Configuration
-------------

Available config.json options::

    {
        "swagger": {
            "authentication_allowed": false,
            "base_configuration": {
                "swagger": "2.0",
                "info": {
                    "version": "",
                    "title": "Guillotina",
                    "description": "The REST Resource API"
                },
                "host": "",
                "basePath": "",
                "schemes": [],
                "produces": [
                    "application/json"
                ],
                "consumes": [
                    "application/json"
                ],
                "paths": {},
                "definitions": {}
            },
            "index_html": null
        }
    }


Viewing swagger for resource
----------------------------

Append `@docs` onto any url: `http://localhost:8080/@docs`.


Generating swagger docs
-----------------------

`guillotina_swagger` reads service configuration.

You can provide additional swagger configuration hints by providing a swagger
configuration with any of the following options:

- ignore: to prevent swagger from aggregating it
- additional_paths: provide a list of additional paths this configuration is used for(think routing here)
- display_permission: if you do not want to show permission setting, set this to false
- tags: what tags to use for it

1.0.14 (2019-06-18)
-------------------

- restrict g compat


1.0.13 (2018-09-26)
-------------------

- Only provide version if not set
  [vangheem]


1.0.12 (2018-09-20)
-------------------

- Be able to customize swagger index.html file
  [vangheem]


1.0.11 (2018-09-14)
-------------------

- bump


1.0.10 (2018-09-13)
-------------------

- More docs and support for customizing more parts of generated
  swagger definition.
  [vangheem]


1.0.8 (2017-06-19)
------------------

- Add permission to documentation
  [vangheem]


1.0.7 (2017-06-18)
------------------

- Tweak UI
  [vangheem]


1.0.6 (2017-06-18)
------------------

- Automatically detect auth tokens and be able to provide own authorization header
  [vangheem]


1.0.5 (2017-06-13)
------------------

- Also pull basePath for swagger from vhm if provided
  [vangheem]


1.0.4 (2017-06-13)
------------------

- Use vhm for host setting on swagger
  [vangheem]


1.0.3 (2017-06-13)
------------------

- Pay attention to vhm


1.0.2 (2017-06-12)
------------------

- be able to provide custom base_url for swagger
  [vangheem]


1.0.1 (2017-06-07)
------------------

- Fix getting path of resource


1.0.0 (2017-04-04)
------------------

- initial release
guillotina-statsd 1.1.2
Integrate statsd into guillotina
License: BSD

guillotina_statsd Docs
======================


Integrates statsd into guillotina.


Configuration
-------------


Example docs::

    {
      "statsd": {
	      "host": "localhost",
	      "port": 8015
	    }
    }

    
Dependencies
------------

Python >= 3.6


Installation
------------

This example will use virtualenv::

  virtualenv .
  ./bin/python setup.py develop


Running
-------

Most simple way to get running::

  ./bin/guillotina
guillotina-mailer 1.1.3
Mailer integration with guillotina
License: BSD
Keywords: async mail guillotina

.. contents::

guillotina_mailer
=================


Configuration
-------------

config.json can include mailer section::

    "applications": ["guillotina_mailer"],
    "mailer": {
      "default_sender": "foo@bar.com",
      "endpoints": {
        "default": {
          "type": "smtp",
          "host": "localhost",
          "port": 25
        }
      }
    }


Printing mailer
---------------

For development/debugging, you can use a console print mailer::

    "applications": ["guillotina_mailer"],
    "mailer": {
      "default_sender": "foo@bar.com",
      "endpoints": {
        "default": {
          "type": "smtp",
          "host": "localhost",
          "port": 25
        }
      },
      "utility": "guillotina_mailer.utility.PrintingMailerUtility"
    }


Sending mail
------------

POST http://localhost:8080/zodb/container/@mailer::

    {
      "sender": "foo@bar.com",
      "recipient": "john@doe.com",
      "subject": "Some subject",
      "text": "Hello"
    }


Permissions
-----------

`guillotina_mailer` defines a permission `mailer.SendMail` which, by default,
only the `guillotina.ContainerAdmin` role is assigned.


Using the mailer in code
------------------------

You can also directly use the mailer in your code::

    from guillotina.component import queryUtility
    from guillotina_mailer.interfaces import IMailer
    mailer = queryUtility(IMailer)
    await mailer.send(recipient='john@doe.com', subject='This is my subject', text='Body of email')

1.1.3 (2019-06-18)
------------------

- Restrict guillotina version


1.1.2 (2018-11-21)
------------------

- Adding options for username and passwd
  [bloodbare]

1.1.1 (2018-11-15)
------------------

- Fix getting empty settings
  [vangheem]

1.1.0 (2018-09-17)
------------------

- Use a retriable async queue to send emails
  [vangheem]

1.0.5 (2018-09-12)
------------------

- Fix tests
  [vangheem]

1.0.4 (2018-09-12)
------------------

- Fix queue
  [vangheem]


1.0.3 (2018-09-12)
------------------

- Fix to make work with latest guillotina
  [vangheem]

1.0.2 (2017-04-13)
------------------

- Register the smtp endpoint
  [vangheem]


1.0.1 (2017-04-10)
------------------

- remove dependencies on repoze.sendmail and transaction
  [vangheem]

- Test mailer did not provide correct signature
  [vangheem]


1.0.0 (2017-04-04)
------------------

- Initial release moved from guillotina_mailer