# Pylint Nautobot
<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/pylint-nautobot/main/docs/images/icon-pylint-nautobot.png" class="logo" height="200px">
<br>
<a href="https://github.com/nautobot/pylint-nautobot/actions"><img src="https://github.com/nautobot/pylint-nautobot/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://docs.nautobot.com/projects/pylint-nautobot/en/latest"><img src="https://readthedocs.org/projects/pylint-nautobot/badge/"></a>
<a href="https://pypi.org/project/pylint-nautobot/"><img src="https://img.shields.io/pypi/v/pylint-nautobot"></a>
<a href="https://pypi.org/project/pylint-nautobot/"><img src="https://img.shields.io/pypi/dm/pylint-nautobot"></a>
<br>
An collection of code linting rules for <a href="https://nautobot.com/">Nautobot</a>.
</p>
## Overview
This project contains custom [pylint](https://github.com/pylint-dev/pylint) rules for linting [Nautobot](https://github.com/nautobot/nautobot) and its Apps.
## Documentation
Full documentation for this project can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
- [Getting Started](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/getting_started/).
- [Development](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/development).
- [Release Notes / Changelog](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/release_notes/).
- [Frequently Asked Questions](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/faq/).
### Contributing to the Documentation
You can find all the Markdown source for the project documentation under the [`docs`](https://github.com/nautobot/pylint-nautobot/tree/main/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/) by running `invoke docs` in your local development environment. As your changes to the documentation files are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
Any PRs with fixes or improvements are very welcome!
## Questions
For any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
Raw data
{
"_id": null,
"home_page": "https://github.com/nautobot/pylint-nautobot",
"name": "pylint-nautobot",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "nautobot, pylint",
"author": "Cristian Sirbu",
"author_email": "cristian.sirbu@networktocode.com",
"download_url": "https://files.pythonhosted.org/packages/6b/b2/4c4d9ed4bfdcec46fad8aaa0aff791f84b541e4d102dba695c70f7abe2af/pylint_nautobot-0.3.1.tar.gz",
"platform": null,
"description": "# Pylint Nautobot\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/nautobot/pylint-nautobot/main/docs/images/icon-pylint-nautobot.png\" class=\"logo\" height=\"200px\">\n <br>\n <a href=\"https://github.com/nautobot/pylint-nautobot/actions\"><img src=\"https://github.com/nautobot/pylint-nautobot/actions/workflows/ci.yml/badge.svg?branch=main\"></a>\n <a href=\"https://docs.nautobot.com/projects/pylint-nautobot/en/latest\"><img src=\"https://readthedocs.org/projects/pylint-nautobot/badge/\"></a>\n <a href=\"https://pypi.org/project/pylint-nautobot/\"><img src=\"https://img.shields.io/pypi/v/pylint-nautobot\"></a>\n <a href=\"https://pypi.org/project/pylint-nautobot/\"><img src=\"https://img.shields.io/pypi/dm/pylint-nautobot\"></a>\n <br>\n An collection of code linting rules for <a href=\"https://nautobot.com/\">Nautobot</a>.\n</p>\n\n## Overview\n\nThis project contains custom [pylint](https://github.com/pylint-dev/pylint) rules for linting [Nautobot](https://github.com/nautobot/nautobot) and its Apps.\n\n## Documentation\n\nFull documentation for this project can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:\n\n- [Getting Started](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/getting_started/).\n- [Development](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/development).\n- [Release Notes / Changelog](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/release_notes/).\n- [Frequently Asked Questions](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/faq/).\n\n### Contributing to the Documentation\n\nYou can find all the Markdown source for the project documentation under the [`docs`](https://github.com/nautobot/pylint-nautobot/tree/main/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.\n\nIf you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/) by running `invoke docs` in your local development environment. As your changes to the documentation files are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.\n\nAny PRs with fixes or improvements are very welcome!\n\n## Questions\n\nFor any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/pylint-nautobot/en/latest/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Custom Pylint Rules for Nautobot",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/nautobot/pylint-nautobot",
"Repository": "https://github.com/nautobot/pylint-nautobot"
},
"split_keywords": [
"nautobot",
" pylint"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "815b6bab362178d69258c706db18d9a36b633503e67e984e25d6c40a7add7df5",
"md5": "9c323f0bc9b292c2882cb12c9774a173",
"sha256": "097bb85405aabe766395a9d09dc474e39c8d9d23700d0e64e21f3855b4188466"
},
"downloads": -1,
"filename": "pylint_nautobot-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c323f0bc9b292c2882cb12c9774a173",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 24270,
"upload_time": "2024-08-22T20:48:44",
"upload_time_iso_8601": "2024-08-22T20:48:44.201391Z",
"url": "https://files.pythonhosted.org/packages/81/5b/6bab362178d69258c706db18d9a36b633503e67e984e25d6c40a7add7df5/pylint_nautobot-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6bb24c4d9ed4bfdcec46fad8aaa0aff791f84b541e4d102dba695c70f7abe2af",
"md5": "111200cd3e4bfa699dbd9c12987ebe4a",
"sha256": "3a637f03dccf29db47d6fdfa348f6fbcd97e9471ade5c8eca7efd0921740dd94"
},
"downloads": -1,
"filename": "pylint_nautobot-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "111200cd3e4bfa699dbd9c12987ebe4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 18070,
"upload_time": "2024-08-22T20:48:45",
"upload_time_iso_8601": "2024-08-22T20:48:45.220008Z",
"url": "https://files.pythonhosted.org/packages/6b/b2/4c4d9ed4bfdcec46fad8aaa0aff791f84b541e4d102dba695c70f7abe2af/pylint_nautobot-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 20:48:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nautobot",
"github_project": "pylint-nautobot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pylint-nautobot"
}
JSON
