semvec/pypi-packages huggingface dataset:
sloth-ci.validators.bitbucket 1.1.1
Bitbucket validator for Sloth CI
License: MIT

Sloth CI validator for `Bitbucket <https://bitbucket.org/>`_ push events.

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

.. code-block:: bash
    
    $ pip install sloth-ci.validators.bitbucket


Usage
-----

.. code-block:: yaml

    provider:
        bitbucket:
            # Repository owner. Mandatory parameter.
            owner: moigagoo

            # Repository title as it appears in the URL, i.e. slug.
            # Mandatory parameter.
            repo: sloth-ci

            # Only pushes to these branches will initiate a build.
            # Skip this parameter to allow all branches to fire builds.
            branches:
                - master
                - staging
snipping 0.2
Edit and run snippet in real time
License: MIT

|Build Status|

Snipping
========

A tool to edit and run **python** snippet in real time.

.. image:: https://raw.githubusercontent.com/yittg/Snipping/master/assets/screenshot.png

Usage
=====

Just run Snipping like this,

::

    $ snipping

Also you can specify the snippet file.

If the file exists, Snipping will read the content, and save to the file
when you ``Save``, if not, Snipping will start from empty snippet, and
save to the file on command.

::

    $ snipping [path/to/snippet]

Special thanks
==============

-  `prompt\_toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>`__
   for the terminal interface.


.. |Build Status| image:: https://travis-ci.org/yittg/Snipping.svg?branch=master
   :target: https://travis-ci.org/yittg/Snipping
sloth-ci.ext.webhooks 1.0.2
Webhooks for Sloth CI
License: MIT

Send POST requests on build events in Sloth CI apps.

Executing actions of an app is called *build*. A build is considered *completed* if all its actions were completed. If some actions were completed and some failed, it's a *partially completed*; if all actions fail, the build *failed*.

This extension sends POST requests when your builds complete (fully or partially) or fail; just pick the desired notification level and the target URL.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.webhooks


Usage
-----

.. code-block:: yaml
    :caption: webhooks.yml

    extensions:
        webhooks:
            # Use the module sloth_ci.ext.webhooks.
            module: webhooks

            # Log level (number or valid Python logging level name).
            # ERROR includes only build fails, WARNING adds partial completions,
            # INFO adds completion, and DEBUG adds trigger notifications.
            # Default is WARNING.
            level: INFO

            # URL to send the requests to.
            url: http://example.com
sloth-ci.ext.ssh_exec 1.1.0
SSH executor for Sloth CI
License: MIT

Run actions on remote machines over SSH.

By default, Sloth CI apps run actions in a subprocess on the same machine they're running on. This extension overrides this and makes the app execute actions on remote machines over SSH.

You can authenticate with login and password or by providing key files.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.ssh_exec


Usage
-----

.. code-block:: yaml
    :caption: ssh_exec.yml

    extensions:
        run_over_ssh:
            # Use the sloth_ci.ext.ssh_exec module.
            module: ssh_exec

            # Hosts, comma-delimited. Optional port number can be provided after ':' (if not specified, 22 is used).
            hosts:
                - ssh.example.com
                - myserver.com:23

            # Username to use for authentication.
            username: admin

            # Password to use for authentication or to unlock a private key.
            # password: foobar

            # Additional private key files. If not specified, only the keys from the default location are loaded (i.e. ~/.ssh).
            # keys: 
            #   - ~/my_ssh_keys/key_rsa
            #   - somekey
sloth-ci.ext.robots_txt 1.0.3
Robots.txt for the Sloth CI server
License: MIT

Robots.txt for the Sloth CI server.

`Robots.txt <https://en.wikipedia.org/wiki/Robots_exclusion_standard>`__ is a file you put on your server to protect certain URLs from being accessed by crawler bots.

By default,tThis extension serves *robots.txt* on the server root, e.g. http://example.com:8080/robots.txt. However, you can specify your own file to serve and the URL to serve it on.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.robots_txt


Usage
-----

.. code-block:: yaml
    :caption: sloth.yml

    extensions:
        robots_txt:
            # Use the sloth_ci.ext.robots_txt module.
            module: robots_txt

            # Absolute path to the custom robots.txt file.
            # If not given, the bundled one is used (disallows everything to everyone).
            # file: ~/robots.txt
 
            # URL path to robots.txt.
            # By default the file is available in the root: *http://example.com:8080/robots.txt*.
            # path: /static/robots.txt
sloth-ci.ext.openvz_exec 1.0.5
OpenVZ executor for Sloth CI
License: MIT

Run actions inside an `OpenVZ <http://openvz.org>`__ container.

By default, Sloth CI apps run actions in a subprocess on the same machine they're running on. This extension overrides this and makes the app execute actions inside a given OpenVZ container.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.openvz_exec


Usage
-----

.. code-block:: yaml
    :caption: openvz_exec.yml

    extensions:
        run_in_openvz:
            # Use the sloth_ci.ext.openvz_exec module.
            module: openvz_exec

            # Container name.
            container_name: foo

            # Container ID.
            # container_id: 123

If ``container_name`` is provided, ``container_id`` is ignored. If ``container_name`` is *not* provided, ``container_id`` is mandatory.
sloth-ci.ext.devtools 1.0.4
Utilities for Sloth CI extension and validator development
License: MIT

Utilities to help you develop extensions and validators for Sloth CI.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.devtools


Usage
-----

Enable the extension in the server config:

.. code-block:: yaml
    :caption: devtools.yml

    extensions:
        dev:
            # Use the module sloth_ci.ext.devtools.
            module: devtools

Call the ``sci dev`` with ``-e`` or ``-v`` to create an extensions or a validator template:

.. code-block:: bash

    $ sci dev -e spam
    Extension "spam" created.

    $ sci dev -v eggs
    Validator "eggs" created.
sloth-ci.ext.file_logs 1.1.3
File logs for Sloth CI apps
License: MIT

Add file logging to Sloth CI apps.

You can customize your logging in a number of ways: set the output dir and filename, set log level and format, toggle and configure log rotation.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.file_logs


Usage
-----

.. code-block:: yaml
    :caption: file_logs.yml

    extensions:
        logs:
            # Use the module sloth_ci.ext.file_logs.
            module: file_logs

            # Set the log path. Default is the current dir.
            path: debug_logs

            # Log filename. If not given, the app's listen point is used.
            filename: test_debug.log

            # Log level (number or valid Python logging level name).
            level: DEBUG

            # Log format (refer to the https://docs.python.org/3/library/logging.html#logrecord-attributes).
            # By default, this format is used: 
            # format: '%(asctime)s | %(name)30s | %(levelname)10s | %(message)s'

            # Make logs rotating. Default is false.
            # rotating: true

            # If rotating, maximum size of a log file in bytes.
            # max_bytes: 500

            # If rotating, maximum number or log files to keep.
            # backup_count: 10
sloth-ci.ext.docker_exec 1.1.3
Docker executor for Sloth CI
License: MIT

Run actions inside a `Docker <https://www.docker.com/>`__ image.

By default, Sloth CI apps run actions in a subprocess on the same machine they're running on. This extension overrides this and makes the app execute each action as a container inside a given Docker image.


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

.. code-block:: bash

    $ pip install sloth-ci.ext.docker_exec


Usage
-----

.. code-block:: yaml
    :caption: docker_exec.yml

    extensions:
        run_in_docker:
            # Use the module sloth_ci.ext.docker_exec.
            module: docker_exec

            # Image name. If missing, slug of the Sloth app listen point is used.
            # image: foo

            # Path to the Docker daemon to connect to. Can point to either a tcp URL or a unix socket. If missing, the client connects to /var/run/docker.sock.
            # base_url: tcp://555.55.55.55:5555 *.

            # Docker API version used on the server. If missing, the latest version is used.
            # version: 1.10

            # Path to the Dockerfile used to build an image if it doesn't exist. If missing, current directory is used.
            # path_to_dockerfile: docker/files

            # Memory limit in MB.
            # memory_limit: 10

            # CPU share in per cent.
            # cpu_share: 5
sloth-ci.validators.gitlab 1.0.2
GitLab validator for Sloth CI
License: MIT

Sloth CI validator for `GitLab <https://about.gitlab.com/>`_ push events.

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

.. code-block:: bash
    
    $ pip install sloth-ci.validators.gitlab


Usage
-----

.. code-block:: yaml

    provider:
        gitlab:
            # Whitelisted GitLab server IPs.
            # Mandatory parameter.
            trusted_ips:
                - 123.45.67.89
                - 111.22.33.44

            # Repository title as it appears in the URL, i.e. slug.
            # Mandatory parameter.
            repo: sloth-ci

            # Only pushes to these branches will initiate a build.
            # Skip this parameter to allow all branches to fire builds.
            branches:
                - master
                - staging
sloth-ci.validators.github 1.1.1
GitHub validator for Sloth CI
License: MIT

Sloth CI validator for `GitHub <https://github.com/>`_ push events.

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

.. code-block:: bash
    
    $ pip install sloth-ci.validators.github


Usage
-----

.. code-block:: yaml

    provider:
        github:
            # Repository owner. Mandatory parameter.
            owner: moigagoo

            # Repository title as it appears in the URL, i.e. slug.
            # Mandatory parameter.
            repo: sloth-ci

            # Only pushes to these branches will initiate a build.
            # Skip this parameter to allow all branches to fire builds.
            branches:
                - master
                - staging