{
    "info": {
        "author": "Jacobi Petrucciani",
        "author_email": "jacobi@mimirhq.com",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: 3.8",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy"
        ],
        "description": "# archives: a new way to do python code documentation\n\n[![image](https://travis-ci.org/jpetrucciani/archives.svg?branch=master)](https://travis-ci.org/jpetrucciani/archives)\n[![PyPI\nversion](https://badge.fury.io/py/archives.svg)](https://badge.fury.io/py/archives)\n[![Code style:\nblack](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Python 3.6+\nsupported](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/release/python-360/)\n[![Documentation style:\narchives](https://img.shields.io/badge/docstyle-archives-lightblue.svg)](https://github.com/jpetrucciani/archives)\n\n**archives** is a new style of python code documentation, as well as a\nlinter for the documentation itself. It can help you ensure that your\ndocstrings in your classes and functions stay up to date, and that they\nadequately explain their purpose, arguments, and return value.\n\n![Perhaps the archives are\nincomplete](https://i.kym-cdn.com/entries/icons/original/000/023/967/obiwan.jpg)\n\n## Features\n\n  - linter for docstrings (work in progress, but usable\\!)\n  - (coming soon) documentation generator\n\n## Usage\n\n### Installation\n\n``` bash\npip install archives\n```\n\n### Run the Linter\n\n``` bash\n# run archives (on itself!)\narchives archives/\n\n# archives.py:846:0: F104 function 'path_empty' missing @ret tag\n#\n# Impossible! Perhaps your archives are incomplete?\n# 1 issues found.\n\n# list tags!\narchives --list-tag\n\n# @arg    describe an argument of a function\n# @author denote the author of a module/class/function\n# @cc     denote the complexity of a function\n# @desc   describe a module/class/function\n# @link   add a link to the generated documentation\n# @nodoc  disable this module/class/function in the documentation\n# @nolint disable archives linting in this module/class/function\n# @note   add a note to a module/class/function\n# @ret    describe the return value of a function\n# @todo   tag something as a todo\n# @warn   add a warning to a module/class/function\n\n# list rules!\narchives --list-rules\n\n\n# disable rules!\narchives --disable M100 .\n\n# different formats for output! defaults to flake8\narchives --format pylint archives.py\n```\n\n## Testing\n\nTests can be run with tox\\!\n\n``` bash\n# run tests\ntox\n\n# only one version of python\ntox -e py36\n```\n\n## Todo\n\n  - more rules\n  - better system for multi-check rules\n  - more output formats\n  - potentially spell-checking inside desc?\n  - documentation generator\n  - tests",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/jpetrucciani/archives.git",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/jpetrucciani/archives.git",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "archives",
        "package_url": "https://pypi.org/project/archives/",
        "platform": "",
        "project_url": "https://pypi.org/project/archives/",
        "project_urls": {
            "Download": "https://github.com/jpetrucciani/archives.git",
            "Homepage": "https://github.com/jpetrucciani/archives.git"
        },
        "release_url": "https://pypi.org/project/archives/0.12/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "a new way to do python code documentation",
        "version": "0.12"
    },
    "last_serial": 5827558,
    "releases": {
        "0.11": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cd0396cb5a587b97a5026265ff1eebe1",
                    "sha256": "ea94af02404332f02130ba89e48d31407ae415700d68f1f3b846f353626e78dd"
                },
                "downloads": -1,
                "filename": "archives-0.11.tar.gz",
                "has_sig": false,
                "md5_digest": "cd0396cb5a587b97a5026265ff1eebe1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13103,
                "upload_time": "2019-09-13T17:33:06",
                "url": "https://files.pythonhosted.org/packages/52/4a/7f110e9b6f8e659842221e2879eca627806a83835e0ecb5a1eab4bb34a47/archives-0.11.tar.gz"
            }
        ],
        "0.12": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1e484da13c5aa3886d5d6c06d8f6f534",
                    "sha256": "c8f7a759cd3bd0e34bf75e64ba27800a4d5d9169ceab3676438ca1b6aad3d981"
                },
                "downloads": -1,
                "filename": "archives-0.12.tar.gz",
                "has_sig": false,
                "md5_digest": "1e484da13c5aa3886d5d6c06d8f6f534",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14256,
                "upload_time": "2019-09-13T20:05:32",
                "url": "https://files.pythonhosted.org/packages/d9/40/ae1743ca8598782fd3bfd64750c3dd98ba7d5fe5a436287b2abf4f42502a/archives-0.12.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d69dc47fdfd049bfcfcd206e5217cf43",
                    "sha256": "806508a62b0fbd85082913901956d829d519364b6467eca28018bbc89b1f184c"
                },
                "downloads": -1,
                "filename": "archives-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "d69dc47fdfd049bfcfcd206e5217cf43",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2244,
                "upload_time": "2019-09-06T17:55:49",
                "url": "https://files.pythonhosted.org/packages/30/56/abcf8a55e6af4c641cada274f5ecf66aec1c54394b7d2a1ae9a0771841aa/archives-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "987ded38ccfd2ef5cc6a64406df98380",
                    "sha256": "11f77839b12ffdc8db95473aa0e6e6f47815b2b0d4f654300a7aadafa6f94d79"
                },
                "downloads": -1,
                "filename": "archives-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "987ded38ccfd2ef5cc6a64406df98380",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2830,
                "upload_time": "2019-09-09T22:54:06",
                "url": "https://files.pythonhosted.org/packages/b8/fa/29d0728a7b93619c818786f536472c4614c9fc0ee89bd3583212c4b835af/archives-0.3.tar.gz"
            }
        ],
        "0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f2446ebbf73335cfba05577c7a5e591",
                    "sha256": "69eb2d4c5bf2c245f4ecd1bd7d67d20845e44fcd5e7344946496fdf5f5854fb4"
                },
                "downloads": -1,
                "filename": "archives-0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "8f2446ebbf73335cfba05577c7a5e591",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8688,
                "upload_time": "2019-09-09T23:05:47",
                "url": "https://files.pythonhosted.org/packages/01/64/3e349ea9915646d19357ca954abc1b332446e4033c116981a05ec9dda398/archives-0.4.tar.gz"
            }
        ],
        "0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "df84849939d4443e8efb0e464c50ef6e",
                    "sha256": "f742ab84c0f917d8c3a6a5754688a480802d5d3138f632b3aca3abcd0c45cde8"
                },
                "downloads": -1,
                "filename": "archives-0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "df84849939d4443e8efb0e464c50ef6e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9269,
                "upload_time": "2019-09-09T23:15:12",
                "url": "https://files.pythonhosted.org/packages/f8/fd/0c0253a55e687479151a8a461a520f131ff318a2833469dd3a731ba6a9eb/archives-0.5.tar.gz"
            }
        ],
        "0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "475f6c44c54dd7b321060d4b2f97775d",
                    "sha256": "b09869150ddb29d63e563d10b37614fb45e6db9bd53869b1ae9e4104c95e11fc"
                },
                "downloads": -1,
                "filename": "archives-0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "475f6c44c54dd7b321060d4b2f97775d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9454,
                "upload_time": "2019-09-10T23:55:39",
                "url": "https://files.pythonhosted.org/packages/cf/56/36c892044a851effd45cf121e2662cb5408eebd4f8e75278d8797edbbd77/archives-0.6.tar.gz"
            }
        ],
        "0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "eeeb69f70cd6fc95b804110064b68368",
                    "sha256": "5d309b495b4733d761bc204a5d9d03ea274a58b26686d35d69c570c0309feb53"
                },
                "downloads": -1,
                "filename": "archives-0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "eeeb69f70cd6fc95b804110064b68368",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10597,
                "upload_time": "2019-09-11T21:13:56",
                "url": "https://files.pythonhosted.org/packages/66/ba/efc48dbf0692718793de22d3ca5b201b5733c6b962bb7c7166706b3a3a56/archives-0.7.tar.gz"
            }
        ],
        "0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "14c81aa5b12f75ae16e8ce41b0cd7135",
                    "sha256": "06969bbaf32711612ed0269a4c519c62a7a036d486a48044976debc8bb06be4d"
                },
                "downloads": -1,
                "filename": "archives-0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "14c81aa5b12f75ae16e8ce41b0cd7135",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12712,
                "upload_time": "2019-09-13T00:03:06",
                "url": "https://files.pythonhosted.org/packages/de/d9/459e1bbf6afc151663baf21228597e60dd880a798633353783ff74276344/archives-0.8.tar.gz"
            }
        ],
        "0.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b70cf5b4d7e46fe3a1f8aa54388c7f53",
                    "sha256": "6dcecc0309233eabf80f764e12b499dd8af2a064eeb6794f53f1221a6f71924a"
                },
                "downloads": -1,
                "filename": "archives-0.9.tar.gz",
                "has_sig": false,
                "md5_digest": "b70cf5b4d7e46fe3a1f8aa54388c7f53",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12876,
                "upload_time": "2019-09-13T00:27:48",
                "url": "https://files.pythonhosted.org/packages/52/14/84b69083633d0196b5ae5560d9c16fda69cc88147d0ed4fb295877eb7348/archives-0.9.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1e484da13c5aa3886d5d6c06d8f6f534",
                "sha256": "c8f7a759cd3bd0e34bf75e64ba27800a4d5d9169ceab3676438ca1b6aad3d981"
            },
            "downloads": -1,
            "filename": "archives-0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "1e484da13c5aa3886d5d6c06d8f6f534",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14256,
            "upload_time": "2019-09-13T20:05:32",
            "url": "https://files.pythonhosted.org/packages/d9/40/ae1743ca8598782fd3bfd64750c3dd98ba7d5fe5a436287b2abf4f42502a/archives-0.12.tar.gz"
        }
    ]
}