Package: nautobot-plugin-meme-otd
Nautobot Meme Of The Day PluginA plugin forNautobot.InstallationThe plugin is available as a Python package in pypi and can be installed with pippipinstallnautobot-plugin-meme-otdThe plugin is compatible with Nautobot 1.4.0 and higherTo ensure Nautobot Meme Of The Day Plugin is automatically re-installed during future upgrades, create a file namedlocal_requirements.txt(if not already existing) in the Nautobot root directory (alongsiderequirements.txt) and list thenautobot-plugin-meme-otdpackage:# echo nautobot-plugin-meme-otd >> local_requirements.txtOnce installed, the plugin needs to be enabled in yournautobot_config.py# In your nautobot_config.pyPLUGINS=["nautobot_meme_otd"]# PLUGINS_CONFIG = {#   "nautobot_meme_otd": {#     ADD YOUR SETTINGS HERE#   }# }The plugin behavior can be controlled with the following list of settingsTODODatabases supported:PostgresMysqlUsageAPITODOContributingPull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of Nautobot through TravisCI.The project is packaged with a light development environment based ondocker-composeto help with the local development of the project and to run the tests within TravisCI.The project is following Network to Code software development guideline and is leveraging:Black, Pylint, Bandit and pydocstyle for Python linting and formatting.Django unit test to ensure the plugin is working properly.Development EnvironmentThe development environment can be used in 2 ways. First, with a local poetry environment if you wish to develop outside of Docker with the caveat of using external services provided by Docker for PostgresQL and Redis. Second, all services are spun up using Docker and a local mount so you can develop locally, but Nautobot is spun up within the Docker container.Below is a quick start guide if you're already familiar with the development environment provided, but if you're not familiar, please read theGetting Started Guide.InvokeThePyInvokelibrary is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to PyInvoke to override the default configuration:nautobot_ver: the version of Nautobot to use as a base for any built docker containers (default: latest)project_name: the default docker compose project name (default: nautobot_meme_otd)python_ver: the version of Python to use as a base for any built docker containers (default: 3.7)local: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)compose_dir: the full path to a directory containing the project compose filescompose_files: a list of compose files applied in order (seeMultiple Compose filesfor more information)UsingPyInvokethese configuration options can be overridden usingseveral methods. Perhaps the simplest is simply setting an environment variableINVOKE_NAUTOBOT_MEME_OTD_VARIABLE_NAMEwhereVARIABLE_NAMEis the variable you are trying to override. The only exception iscompose_files, because it is a list it must be overridden in a yaml file. There is an exampleinvoke.yml(invoke.example.yml) in this directory which can be used as a starting point.Local Poetry Development EnvironmentCopydevelopment/creds.example.envtodevelopment/creds.env(This file will be ignored by Git and Docker)Uncomment theNAUTOBOT_DB_HOST,NAUTOBOT_REDIS_HOST, andNAUTOBOT_CONFIGvariables indevelopment/creds.envCreate aninvoke.ymlfile with the following contents at the root of the repo (you can alsocp invoke.example.yml invoke.ymland edit as necessary):---{{cookiecutter.plugin_name}}:local:truecompose_files:-"docker-compose.requirements.yml"Run the following commands:poetryshell
poetryinstall--extrasnautobotexport$(catdevelopment/dev.env|xargs)export$(catdevelopment/creds.env|xargs)invokestart&&sleep5nautobot-servermigrateIf you want to develop on the latest develop branch of Nautobot, run the following command:poetry add --optional git+https://github.com/nautobot/nautobot@develop. After the@symbol must match either a branch or a tag.You can now run nautobot-server commands as you would from theNautobot documentationfor example to start the development server:nautobot-serverrunserver0.0.0.0:8080--insecureNautobot server can now be accessed athttp://localhost:8080.It is typically recommended to launch the Nautobotrunservercommand in a separate shell so you can keep developing and manage the webserver separately.Docker Development EnvironmentThis project is managed byPython Poetryand has a few requirements to setup your development environment:Install Poetry, see thePoetry Documentationfor your operating system.Install Docker, see theDocker documentationfor your operating system.Once you have Poetry and Docker installed you can run the following commands to install all other development dependencies in an isolated python virtual environment:poetryshell
poetryinstall
invokestartNautobot server can now be accessed athttp://localhost:8080.To either stop or destroy the development environment use the following options.invoke stop- Stop the containers, but keep all underlying systems intactinvoke destroy- Stop and remove all containers, volumes, etc. (This results in data loss due to the volume being deleted)CLI Helper CommandsThe project is coming with a CLI helper based oninvoketo help setup the development environment. The commands are listed below in 3 categoriesdev environment,utilityandtesting.Each command can be executed withinvoke <command>. Environment variablesINVOKE_NAUTOBOT_MEME_OTD_PYTHON_VERandINVOKE_NAUTOBOT_MEME_OTD_NAUTOBOT_VERmay be specified to override the default versions. Each command also has its own helpinvoke <command> --helpDocker dev environmentbuild            Build all docker images.
  debug            Start Nautobot and its dependencies in debug mode.
  destroy          Destroy all containers and volumes.
  restart          Restart Nautobot and its dependencies.
  start            Start Nautobot and its dependencies in detached mode.
  stop             Stop Nautobot and its dependencies.Utilitycli              Launch a bash shell inside the running Nautobot container.
  create-user      Create a new user in django (default: admin), will prompt for password.
  makemigrations   Run Make Migration in Django.
  nbshell          Launch a nbshell session.
  shell-plus       Launch a shell_plus session, which uses iPython and automatically imports all models.Testingbandit           Run bandit to validate basic static code security analysis.
  black            Run black to check that Python files adhere to its style standards.
  flake8           This will run flake8 for the specified name and Python version.
  pydocstyle       Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
  pylint           Run pylint code analysis.
  tests            Run all tests for this plugin.
  unittest         Run Django unit tests for the plugin.Project DocumentationProject documentation is generated bymkdocsfrom the documentation located in the docs folder. You can configurereadthedocs.ioto point at this folder in your repo. A container hosting the docs will be started using the invoke commands onhttp://localhost:8001, as changes are saved the docs will be automatically reloaded.QuestionsFor any questions or comments, please check theFAQfirst and feel free to swing by theNetwork to Code slack channel(channel #networktocode).
Sign uphereScreenshotsTODO