{
    "info": {
        "author": "Daniil Minukhin",
        "author_email": "ddddsa@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Documentation",
            "Topic :: Utilities"
        ],
        "description": "# GitLab notifier config tool\n\nCLI extension for Foliant to set up [GitLab notifier](https://gitlab.com/ddddsa/gitlab_notifier) config for the project.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.notifier\n```\n\n## Usage\n\n> Note that to use this command you will have to specify valid [config](#config) first!\n\nApply notifications for this repo:\n\n```bash\n$ foliant notifier setup\n```\n\nDisable notifications in this repo:\n\n```bash\n$ foliant notifier disable\n```\n\n## Config\n\nBefore running notifier command you will have to supply valid config. Set it up under the `notifier` section in your `foliant.yml`.\n\nIn basic form `notifier` contents should be filled as explained in [GitLab notifier Config section](https://gitlab.com/ddddsa/gitlab_notifier#config), for example:\n\n```yaml\nnotifier:\n    mail_config:\n        host: mail.example.com\n        port: 587\n        user: notifier@example.com\n        password: currently_stored_as_plain_text\n    projects:\n        test-project:\n            - match:\n                - test1.txt\n                - test/file1.txt\n              mailing_list:\n                - john@gmail.com\n                - sam@gmail.com\n            - mailing_list:\n                - sam@gmail.com\n              match:\n                - test1.txt\n                - test/*\n              ignore:\n                - file3.txt\n```\n\n`mail_config` \u2014 Credentials of the mail server account which will send the notifications.\n\n`projects` \u2014 section, describing GitLab-projects which are being tracked.\n\n`test-project` \u2014 name of the project. That one which you see in your browser address bar: gitlab.com/username/**test-project**. In our case this should be the name of our foliant-project in GitLab.\n\nNext goes a list with tracking settings. Each group can have following sections:\n\n`mailing_list` \u2014 list of email-addresses, which will receive notifications.\n\n`match` \u2014 list of [glob](https://en.wikipedia.org/wiki/Glob_(programming))-like patterns. If files in the repository, which match these patterns, are changed, script will send notifications to the mailing_list, set up in this group.\n\n`ignore` \u2014 list of glob-like patterns of files to ignore.\n\n### Additional options\n\nPreprocessor also has some additional options which allow to tune its behavior:\n\n```yaml\nnotifier:\n    repo_url: 'https://gitlab.com/ddddsa/gitlab_notifier.git'\n    config: 'notifier_config.yml'\n    stage: 'notify'\n    job: 'notifier'\n    image: 'python:latest'\n    branches:\n        - 'develop'\n    python: 3\n```\n\n`repo_url`\n:   URL of the GitLab notifier script repository to be used.\n\n`config`\n:   Name of the generated config file for the script.\n\n`stage`\n:   Name of the stage to used in the job in `.gitlab-ci.yml`.\n\n`job`\n:   Job name for the notifier in `.gitlab-ci.yml`.\n\n`image`\n:   Name of the Docker image to be used to run the script. Default is `python:latest`. Set to empty string `''` to use `.gitlab-ci.yml` global image.\n\n`branches`\n:   List of branch names for which the notifications are enabled.\n\n`python`\n:   Python version which is used in the Docker image which will run the script.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/foliant-docs/foliantcontrib.notifier",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "foliantcontrib.notifier",
        "package_url": "https://pypi.org/project/foliantcontrib.notifier/",
        "platform": "any",
        "project_url": "https://pypi.org/project/foliantcontrib.notifier/",
        "project_urls": {
            "Homepage": "https://github.com/foliant-docs/foliantcontrib.notifier"
        },
        "release_url": "https://pypi.org/project/foliantcontrib.notifier/1.0.0/",
        "requires_dist": [
            "foliant (>=1.0.4)"
        ],
        "requires_python": "",
        "summary": "GitLab notifier config tool.",
        "version": "1.0.0"
    },
    "last_serial": 5790260,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bd2cab18d241af0dc9aeec7a9ff8c185",
                    "sha256": "67a0bb369ca057cd4be56ea7dd8f3a229a0677b9157c51e0e13227ef03ff25ef"
                },
                "downloads": -1,
                "filename": "foliantcontrib.notifier-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "bd2cab18d241af0dc9aeec7a9ff8c185",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5458,
                "upload_time": "2019-03-18T13:56:09",
                "url": "https://files.pythonhosted.org/packages/23/ba/2ed99d9c873fee8ff54c699af0be423c7c74c16abfa8185baf84a41ee3df/foliantcontrib.notifier-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "31d38009ed514ba57bdb67e4cf80e4da",
                    "sha256": "d867ca16e06df29b62407373b7eac914a91ec989050a2e46a12188ff66d00f91"
                },
                "downloads": -1,
                "filename": "foliantcontrib.notifier-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "31d38009ed514ba57bdb67e4cf80e4da",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4566,
                "upload_time": "2019-03-18T13:56:11",
                "url": "https://files.pythonhosted.org/packages/6d/7e/481c9288417ad8ab1efd6bbf9ff3189d546d1975e236d9d7182607b3aec6/foliantcontrib.notifier-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "bd2cab18d241af0dc9aeec7a9ff8c185",
                "sha256": "67a0bb369ca057cd4be56ea7dd8f3a229a0677b9157c51e0e13227ef03ff25ef"
            },
            "downloads": -1,
            "filename": "foliantcontrib.notifier-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bd2cab18d241af0dc9aeec7a9ff8c185",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5458,
            "upload_time": "2019-03-18T13:56:09",
            "url": "https://files.pythonhosted.org/packages/23/ba/2ed99d9c873fee8ff54c699af0be423c7c74c16abfa8185baf84a41ee3df/foliantcontrib.notifier-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "31d38009ed514ba57bdb67e4cf80e4da",
                "sha256": "d867ca16e06df29b62407373b7eac914a91ec989050a2e46a12188ff66d00f91"
            },
            "downloads": -1,
            "filename": "foliantcontrib.notifier-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "31d38009ed514ba57bdb67e4cf80e4da",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4566,
            "upload_time": "2019-03-18T13:56:11",
            "url": "https://files.pythonhosted.org/packages/6d/7e/481c9288417ad8ab1efd6bbf9ff3189d546d1975e236d9d7182607b3aec6/foliantcontrib.notifier-1.0.0.tar.gz"
        }
    ]
}