# Nautobot Floor Plan
<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/icon-nautobot-floor-plan.png" class="logo" height="200px">
<br>
<a href="https://github.com/nautobot/nautobot-plugin-floor-plan/actions"><img src="https://github.com/nautobot/nautobot-plugin-floor-plan/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://docs.nautobot.com/projects/floor-plan/en/latest"><img src="https://readthedocs.org/projects/nautobot-plugin-floor-plan/badge/"></a>
<a href="https://pypi.org/project/nautobot-floor-plan/"><img src="https://img.shields.io/pypi/v/nautobot-floor-plan"></a>
<a href="https://pypi.org/project/nautobot-floor-plan/"><img src="https://img.shields.io/pypi/dm/nautobot-floor-plan"></a>
<br>
An <a href="https://www.networktocode.com/nautobot/apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
</p>
## Overview
This App aids in data center management by providing the ability to create a gridded representation of the floor plan of a Nautobot Location and indicate the relative location of each Nautobot Rack within that floor plan.
### Screenshots
More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/floor-plan/en/latest/user/app_use_cases/) page in the documentation.
## Documentation
Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
- [User Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
- [Administrator Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
- [Developer Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
- [Release Notes / Changelog](https://docs.nautobot.com/projects/floor-plan/en/latest/admin/release_notes/).
- [Frequently Asked Questions](https://docs.nautobot.com/projects/floor-plan/en/latest/user/faq/).
### Contributing to the Documentation
You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-plugin-floor-plan/tree/develop/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/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation 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/floor-plan/en/latest/user/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/nautobot-plugin-floor-plan",
"name": "nautobot-floor-plan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "nautobot,nautobot-plugin",
"author": "Network to Code, LLC",
"author_email": "info@networktocode.com",
"download_url": "https://files.pythonhosted.org/packages/df/9c/bd2c9265efe12f303a80cccd80193cb6782c887de3181536b480a59119d3/nautobot_floor_plan-1.0.0.tar.gz",
"platform": null,
"description": "# Nautobot Floor Plan\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/icon-nautobot-floor-plan.png\" class=\"logo\" height=\"200px\">\n <br>\n <a href=\"https://github.com/nautobot/nautobot-plugin-floor-plan/actions\"><img src=\"https://github.com/nautobot/nautobot-plugin-floor-plan/actions/workflows/ci.yml/badge.svg?branch=main\"></a>\n <a href=\"https://docs.nautobot.com/projects/floor-plan/en/latest\"><img src=\"https://readthedocs.org/projects/nautobot-plugin-floor-plan/badge/\"></a>\n <a href=\"https://pypi.org/project/nautobot-floor-plan/\"><img src=\"https://img.shields.io/pypi/v/nautobot-floor-plan\"></a>\n <a href=\"https://pypi.org/project/nautobot-floor-plan/\"><img src=\"https://img.shields.io/pypi/dm/nautobot-floor-plan\"></a>\n <br>\n An <a href=\"https://www.networktocode.com/nautobot/apps/\">App</a> for <a href=\"https://nautobot.com/\">Nautobot</a>.\n</p>\n\n## Overview\n\nThis App aids in data center management by providing the ability to create a gridded representation of the floor plan of a Nautobot Location and indicate the relative location of each Nautobot Rack within that floor plan.\n\n### Screenshots\n\n\n\n\n\n\n\n\n\nMore screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/floor-plan/en/latest/user/app_use_cases/) page in the documentation.\n\n## Documentation\n\nFull documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:\n\n- [User Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.\n- [Administrator Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.\n- [Developer Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.\n- [Release Notes / Changelog](https://docs.nautobot.com/projects/floor-plan/en/latest/admin/release_notes/).\n- [Frequently Asked Questions](https://docs.nautobot.com/projects/floor-plan/en/latest/user/faq/).\n\n### Contributing to the Documentation\n\nYou can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-plugin-floor-plan/tree/develop/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/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/floor-plan/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation 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/floor-plan/en/latest/user/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": "Nautobot Floor Plan",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/nautobot/nautobot-plugin-floor-plan",
"Repository": "https://github.com/nautobot/nautobot-plugin-floor-plan"
},
"split_keywords": [
"nautobot",
"nautobot-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f1f6036294f9885129ca7d75b203eb75031e675eda3c943da1949070d3091e6",
"md5": "b40e6f431b53bc2948e3e30da9a5683f",
"sha256": "0ce1e1082859e2b5ff722f1c77ad68bcdbf0788335c4061b6a92423ad963e667"
},
"downloads": -1,
"filename": "nautobot_floor_plan-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b40e6f431b53bc2948e3e30da9a5683f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 33527,
"upload_time": "2023-07-13T13:06:50",
"upload_time_iso_8601": "2023-07-13T13:06:50.990068Z",
"url": "https://files.pythonhosted.org/packages/4f/1f/6036294f9885129ca7d75b203eb75031e675eda3c943da1949070d3091e6/nautobot_floor_plan-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df9cbd2c9265efe12f303a80cccd80193cb6782c887de3181536b480a59119d3",
"md5": "0bb5f5a3e4db22fe950c813146ce89e7",
"sha256": "0762d9d333a64fe1dc80262da4375e7e8d1689ad2dfd62747c17aea954c94498"
},
"downloads": -1,
"filename": "nautobot_floor_plan-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0bb5f5a3e4db22fe950c813146ce89e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 23010,
"upload_time": "2023-07-13T13:06:52",
"upload_time_iso_8601": "2023-07-13T13:06:52.417745Z",
"url": "https://files.pythonhosted.org/packages/df/9c/bd2c9265efe12f303a80cccd80193cb6782c887de3181536b480a59119d3/nautobot_floor_plan-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-13 13:06:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nautobot",
"github_project": "nautobot-plugin-floor-plan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nautobot-floor-plan"
}
JSON
