{
    "info": {
        "author": "Frances Hocutt",
        "author_email": "frances.hocutt+pypi@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Topic :: Software Development :: Documentation",
            "Topic :: Software Development :: Version Control"
        ],
        "description": "# Open Project Linter\n\n##About this project\nThe Open Project Linter is an automated checklist that new (or experienced\nbut forgetful) open source maintainers can use to make sure that they're\nusing good practices in their documentation, code, and project resources.\n\nThe project started as a way to automate\n[this checklist for newsroom developers](https://docs.google.com/document/d/1kTtHAgzlyteODMia1JmIGbKkjGugxKMZfxoWEGdku_Q/edit#),\nbut these are good practices for most open source projects!\n\nThis is written in and supported on Python 3.\n\n##Getting Started\n###Installation\nIt is recommended that you use a virtual environment in order to avoid\ndependency conflicts between projects. For more information,\n[a tutorial on virtual environments](http://docs.python-guide.org/en/latest/dev/virtualenvs/).\nOnce you have set up a python3 virtual environment, activate the environment.\nThen you can use pip to install Open Project Linter.\n```\n$ pip install open-project-linter\n```\nOnce you have installed the package, you should be able to run it from the\ncommand line (see [Example usage](#Example usage)).\n\n###Example usage\nOnce you have installed the package, if you want to check a local repository,\nmake sure your virtual enviroment is activated and run:\n```\n$ openlinter -d path/to/repository/\n```\n\nFor more help, run `$ openlinter --help`.\n\n####Using configuration files\nOpen Project Linter is configurable, so that you can decide what project\nfeatures you want to check for and what file names you want to make sure\nexist. The default configuration file is located at\n`path/to/openlinter/rules.yml`.\n\nYou can also use the `-r` flag to specify where your desired configuration file\nis, like so:\n```\n$ openlinter -r path/to/rules.yml -d path/to/repository/\n```\nto use the file located at `path/to/rules.yml` to check the repository at\n`path/to/repository/`.\n\n## Contributing\n###How to set up the dev environment\nTo set this up for development, fork this repository, then clone it to\nyour development machine using `git clone`.\n\nOnce you've committed your changes and pushed them to your fork of the\nrepository, file a pull request to get your contribution into the main\nrepository.\n\n##Changelog\n###version 1.0.1\n* Fix the error in checking for multiple commits where it was using the reflog\n  not the commit history ([#30](https://github.com/OpenNewsLabs/open-project-linter/issues/30))\n\n###version 1.0\n* Update `ROADMAP.md` with pre-NICAR status\n* Fix the KeyError issue when default config was changed ([#27](https://github.com/OpenNewsLabs/open-project-linter/issues/27))\n* Split some of the main linter logic out into functions and improve module\n  documentation\n* Add test fixtures for the git-related tests ([#22](https://github.com/OpenNewsLabs/open-project-linter/issues/22))\n\n###version 0.4dev\n* Now installs Pygments automatically when installed with pip, with or\n  without pulling versions from `requirements.txt`\n* Now includes `rules.yml` in the package and uses a correct default path\n  to it\n\n###version 0.3dev\n* Improve documentation\n* Fix accidental return value change in file content checker\n\n###version 0.2dev\n* Add automated tests\n* Fix path bug in file content checker\n\n###version 0.1dev\n* Command-line application invokable with `openlinter`, with help on\n  how to run it\n* Given the path to a directory, checks for:\n    * the existence of license, contributing, and readme files\n    * the presence of code files in the directory and any subdirectories\n    * the presence of a git repository, multiple branches,\n      multiple commits on any branch, and a named development/feature branch\n* Configurable via `rules.yml`\n\n##About\nThis linter was designed and written by [Frances Hocutt](https://franceshocutt.com/cv/) via [Changeset Consulting](http://changeset.nyc/), a project management and maintainership consultancy focusing on open source. Sumana Harihareswara of Changeset Consulting attended the initial [OpenNews](https://opennews.org/) documentation sprint for [The Field Guide to Open Source in the Newsroom](http://fieldguide.opennews.org/) and suggested development of a companion tool to automate the guidebook's checklists as much as possible.\n\nWe look forward to seeing the community add new linter rules to help new maintainers.\n\n##Contributors\n* Frances Hocutt - https://franceshocutt.com https://github.com/fhocutt/\n* Sumana Harihareswara - https://changeset.nyc\n\n##License\nThe Open Project Linter is available under v. 2.0 of the Apache license.\nSee `LICENSE` for more information.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/OpenNewsLabs/open-project-linter",
        "keywords": "project linter setup documentation development",
        "license": "Apache v2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "open-project-linter",
        "package_url": "https://pypi.org/project/open-project-linter/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/open-project-linter/",
        "project_urls": {
            "Homepage": "https://github.com/OpenNewsLabs/open-project-linter"
        },
        "release_url": "https://pypi.org/project/open-project-linter/1.0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Automatic checklist for open source project best practices.",
        "version": "1.0.1"
    },
    "last_serial": 2681735,
    "releases": {
        "0.1dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "aba8668fef53c56d3c40f6794af7866b",
                    "sha256": "df7458247ef66869a2ab98814fa9caa6880288c47e31a68f8537958d1ce7b40c"
                },
                "downloads": -1,
                "filename": "open_project_linter-0.1dev-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "aba8668fef53c56d3c40f6794af7866b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9086,
                "upload_time": "2017-02-17T06:48:08",
                "url": "https://files.pythonhosted.org/packages/71/dd/00df9319554516c4499c570dab878ca55fa442921f89d8fd64e42f5ef78f/open_project_linter-0.1dev-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c80b5ca5270e4a4a3b419a4e3618ef8",
                    "sha256": "8b0104d1cfd4c34a4fb9ef567cf46f769715180b53c717e6b97c4688a5929521"
                },
                "downloads": -1,
                "filename": "open-project-linter-0.1dev.tar.gz",
                "has_sig": false,
                "md5_digest": "6c80b5ca5270e4a4a3b419a4e3618ef8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5415,
                "upload_time": "2017-02-17T06:48:10",
                "url": "https://files.pythonhosted.org/packages/d6/3e/83575805ef0a93d8b27a2e8463d1be2e7d448ed14cac974a48f0cc7d1e5c/open-project-linter-0.1dev.tar.gz"
            }
        ],
        "0.2dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f66deb70f588a9d41dbe555b8f9c18eb",
                    "sha256": "a96d161460fc854eadb7c77a98999eae9b41685763d725a5bdacc56d82a6159a"
                },
                "downloads": -1,
                "filename": "open_project_linter-0.2dev-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f66deb70f588a9d41dbe555b8f9c18eb",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9134,
                "upload_time": "2017-02-22T10:57:14",
                "url": "https://files.pythonhosted.org/packages/e5/be/6caf3deda5d0cee47710087b442cb9d050a04a8ff9b64d383e742da9567d/open_project_linter-0.2dev-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7fa862608272f7da447252c4c729340f",
                    "sha256": "1ad6d75eeeca1ea2476b725c1df456408d8e87e7bcb467299f8971a2fcac371f"
                },
                "downloads": -1,
                "filename": "open-project-linter-0.2dev.tar.gz",
                "has_sig": false,
                "md5_digest": "7fa862608272f7da447252c4c729340f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5424,
                "upload_time": "2017-02-22T10:56:45",
                "url": "https://files.pythonhosted.org/packages/81/5e/8a3ca051b8c9b4dd8bf4b346057acd6b6627a5abb864f56c6dd1fba83bfb/open-project-linter-0.2dev.tar.gz"
            }
        ],
        "0.3dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e0066883e8e0f8cf41ac4174d49de2ce",
                    "sha256": "0e1682ef50a9f432a03242834951bb4419b45edbc7cd35fe4f8d625ef497bdda"
                },
                "downloads": -1,
                "filename": "open_project_linter-0.3dev-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e0066883e8e0f8cf41ac4174d49de2ce",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10051,
                "upload_time": "2017-02-24T09:21:45",
                "url": "https://files.pythonhosted.org/packages/e3/50/3931bc97d570074eaf8a4cdc16adc1ed4ef2cc3136994f4826beff320ffa/open_project_linter-0.3dev-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e42e6bad8c4a7ea87e1f66d814eabd4b",
                    "sha256": "e140bb1afa2c5ebcb9c42bba32c02546ec13381ebdb89cf30271789257d120e7"
                },
                "downloads": -1,
                "filename": "open-project-linter-0.3dev.tar.gz",
                "has_sig": false,
                "md5_digest": "e42e6bad8c4a7ea87e1f66d814eabd4b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6321,
                "upload_time": "2017-02-24T09:21:33",
                "url": "https://files.pythonhosted.org/packages/aa/8e/532b4502457d92597a171db513016184569897467393c2e6f302e98a4f26/open-project-linter-0.3dev.tar.gz"
            }
        ],
        "0.4dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e30672c0bd6cf406b9f507791342d84f",
                    "sha256": "e61cf80bf3f542ee88003b0ac01d39341b575d28ccf0995a4fa041523de79a26"
                },
                "downloads": -1,
                "filename": "open_project_linter-0.4dev-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e30672c0bd6cf406b9f507791342d84f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 11354,
                "upload_time": "2017-02-27T21:55:39",
                "url": "https://files.pythonhosted.org/packages/2f/84/e6ca28d3329f8d91791bdaa52a77399dea7b0368499b3324daeb11860ec9/open_project_linter-0.4dev-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f47720e8af3afd6f6888c2c25cd5ff8",
                    "sha256": "44b2c4261211ad3d0aabb097f909a7effde82acc7efb68d30de45b673a108143"
                },
                "downloads": -1,
                "filename": "open-project-linter-0.4dev.tar.gz",
                "has_sig": false,
                "md5_digest": "8f47720e8af3afd6f6888c2c25cd5ff8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6932,
                "upload_time": "2017-02-27T21:56:01",
                "url": "https://files.pythonhosted.org/packages/75/0e/d1bf0d60465601c3719cd5d883bcfcc960a6cf2897c6b36c8cb3d6f97c6c/open-project-linter-0.4dev.tar.gz"
            }
        ],
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c5316ea4db7315c7fa002467de99b3f8",
                    "sha256": "55f5d560d4e58d765080b0bd2d44eea49876667989eb739334a9a9316a795cc1"
                },
                "downloads": -1,
                "filename": "open_project_linter-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c5316ea4db7315c7fa002467de99b3f8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 11958,
                "upload_time": "2017-03-03T06:27:03",
                "url": "https://files.pythonhosted.org/packages/db/e0/11fe1069de3ee565f61294b92d77f40abfdac269c7352de95b62e006e971/open_project_linter-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6efaf621164c8b257bf66f837169dc99",
                    "sha256": "287d613b9a4836029ef8e29e196c4782fe921199d410dc136688d777394d80cb"
                },
                "downloads": -1,
                "filename": "open-project-linter-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6efaf621164c8b257bf66f837169dc99",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7444,
                "upload_time": "2017-03-03T06:27:19",
                "url": "https://files.pythonhosted.org/packages/f3/06/a1982a17ef5e20ef0afb4d61aa62fa6c983c1d39c94a2e8847616c44b906/open-project-linter-1.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d309676bd58a9353afe3e132218d9b1a",
                    "sha256": "112fd113037258a841fd7ade695d232c8d05479f599d8fe775efea2c71e61ff9"
                },
                "downloads": -1,
                "filename": "open_project_linter-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d309676bd58a9353afe3e132218d9b1a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12455,
                "upload_time": "2017-03-04T02:53:08",
                "url": "https://files.pythonhosted.org/packages/9c/a8/5ae10eb72966526fd165a3f8a106a6ac57a87acdd3464ab845d9f290ec7f/open_project_linter-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0f761eb643ce7515cc4d74cbe3ea205b",
                    "sha256": "7f882028b3d61d2d379fb5e0a933e74bf23d001f77af9a8e101c585e0843ba8a"
                },
                "downloads": -1,
                "filename": "open-project-linter-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "0f761eb643ce7515cc4d74cbe3ea205b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7682,
                "upload_time": "2017-03-04T02:52:54",
                "url": "https://files.pythonhosted.org/packages/a8/c8/32b88de8aaa1eb51423201c1338709a31ed0340148b9a1d71c60c34a39de/open-project-linter-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d309676bd58a9353afe3e132218d9b1a",
                "sha256": "112fd113037258a841fd7ade695d232c8d05479f599d8fe775efea2c71e61ff9"
            },
            "downloads": -1,
            "filename": "open_project_linter-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d309676bd58a9353afe3e132218d9b1a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12455,
            "upload_time": "2017-03-04T02:53:08",
            "url": "https://files.pythonhosted.org/packages/9c/a8/5ae10eb72966526fd165a3f8a106a6ac57a87acdd3464ab845d9f290ec7f/open_project_linter-1.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0f761eb643ce7515cc4d74cbe3ea205b",
                "sha256": "7f882028b3d61d2d379fb5e0a933e74bf23d001f77af9a8e101c585e0843ba8a"
            },
            "downloads": -1,
            "filename": "open-project-linter-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0f761eb643ce7515cc4d74cbe3ea205b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7682,
            "upload_time": "2017-03-04T02:52:54",
            "url": "https://files.pythonhosted.org/packages/a8/c8/32b88de8aaa1eb51423201c1338709a31ed0340148b9a1d71c60c34a39de/open-project-linter-1.0.1.tar.gz"
        }
    ]
}