mkdocs-auto-tag-plugin


Namemkdocs-auto-tag-plugin JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/six-two/mkdocs-auto-tag-plugin
SummaryAdd tags to your MkDocs pages based on their path / file name
upload_time2022-12-31 14:43:31
maintainer
docs_urlNone
authorsix-two
requires_python>=3.9
licenseMIT License
keywords
VCS
bugtrack_url
requirements mkdocs mkdocs-material mkdocs-badges
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # mkdocs-auto-tag-plugin
[![PyPI version](https://img.shields.io/pypi/v/mkdocs-auto-tag-plugin)](https://pypi.org/project/mkdocs-auto-tag-plugin/)
![License](https://img.shields.io/pypi/l/mkdocs-auto-tag-plugin)
![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-auto-tag-plugin)

This plugin is designed to add tags to files based on their path (parent direcctories or file name).

## Documentation

This README is just a short intro to the package.
For a quick start and detailed information please see the [documentation](https://mkdocs-auto-tag-plugin.six-two.dev/).
The documentation is also available in the `docs` folder of the source code and can be built localy with [MkDocs](https://www.mkdocs.org/).

## Tests

The files in the `docs/test/` directory implicitely work as tests.
They should be tagged correctly.


## Notable changes

### HEAD

### 0.1.2

- Just small documentation changes. But I needed to increase the version number to remove the `!!! Warning: Pre alpha: This is currently just a PoC for myself` line from the PyPI site

### 0.1.1

- Added support for assigning lists of tag to globs.
- Added regex support
    - Capture groups can be used to generate dynamic tags

### 0.1.0

- Implemented working prototype that uses custom globs for the file path matching.

### 0.0.1

- Reserved name on PyPI


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/six-two/mkdocs-auto-tag-plugin",
    "name": "mkdocs-auto-tag-plugin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "six-two",
    "author_email": "pip@six-two.dev",
    "download_url": "https://files.pythonhosted.org/packages/a2/00/3fe65b5e8a65bdf7c041122dc2cfa7d5d1f14295b5431868135a0cf35188/mkdocs-auto-tag-plugin-0.1.2.tar.gz",
    "platform": null,
    "description": "# mkdocs-auto-tag-plugin\n[![PyPI version](https://img.shields.io/pypi/v/mkdocs-auto-tag-plugin)](https://pypi.org/project/mkdocs-auto-tag-plugin/)\n![License](https://img.shields.io/pypi/l/mkdocs-auto-tag-plugin)\n![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-auto-tag-plugin)\n\nThis plugin is designed to add tags to files based on their path (parent direcctories or file name).\n\n## Documentation\n\nThis README is just a short intro to the package.\nFor a quick start and detailed information please see the [documentation](https://mkdocs-auto-tag-plugin.six-two.dev/).\nThe documentation is also available in the `docs` folder of the source code and can be built localy with [MkDocs](https://www.mkdocs.org/).\n\n## Tests\n\nThe files in the `docs/test/` directory implicitely work as tests.\nThey should be tagged correctly.\n\n\n## Notable changes\n\n### HEAD\n\n### 0.1.2\n\n- Just small documentation changes. But I needed to increase the version number to remove the `!!! Warning: Pre alpha: This is currently just a PoC for myself` line from the PyPI site\n\n### 0.1.1\n\n- Added support for assigning lists of tag to globs.\n- Added regex support\n    - Capture groups can be used to generate dynamic tags\n\n### 0.1.0\n\n- Implemented working prototype that uses custom globs for the file path matching.\n\n### 0.0.1\n\n- Reserved name on PyPI\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Add tags to your MkDocs pages based on their path / file name",
    "version": "0.1.2",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f8a6f4f026fe77424fd500b41c8785c1",
                "sha256": "8e0fc02bae3d74cb16f77721160881b44ea352d3543f94145fe64b64f903936b"
            },
            "downloads": -1,
            "filename": "mkdocs_auto_tag_plugin-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f8a6f4f026fe77424fd500b41c8785c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 6632,
            "upload_time": "2022-12-31T14:43:30",
            "upload_time_iso_8601": "2022-12-31T14:43:30.308261Z",
            "url": "https://files.pythonhosted.org/packages/e2/f0/5482d58e59f5930aa3152344358d453df417bc42ae2963686623a726d519/mkdocs_auto_tag_plugin-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "50888691cca0acacea3bbd56c6dd79f0",
                "sha256": "b0f7eeb9a4fd2107955f8a5dc2dc7d608bb9ba8443a4018164ea9b7d9befbd95"
            },
            "downloads": -1,
            "filename": "mkdocs-auto-tag-plugin-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "50888691cca0acacea3bbd56c6dd79f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5758,
            "upload_time": "2022-12-31T14:43:31",
            "upload_time_iso_8601": "2022-12-31T14:43:31.912447Z",
            "url": "https://files.pythonhosted.org/packages/a2/00/3fe65b5e8a65bdf7c041122dc2cfa7d5d1f14295b5431868135a0cf35188/mkdocs-auto-tag-plugin-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-31 14:43:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "six-two",
    "github_project": "mkdocs-auto-tag-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "mkdocs",
            "specs": [
                [
                    "==",
                    "1.4.1"
                ]
            ]
        },
        {
            "name": "mkdocs-material",
            "specs": [
                [
                    "==",
                    "8.5.7"
                ]
            ]
        },
        {
            "name": "mkdocs-badges",
            "specs": [
                [
                    "==",
                    "0.4.0"
                ]
            ]
        }
    ],
    "lcname": "mkdocs-auto-tag-plugin"
}
        
Elapsed time: 0.05239s