Skip to content

Nautobot Environment Setup

Prerequisites

  • Install invoke: pip install invoke
  • Install cookiecutter: pip install cookiecutter
  • Install poetry curl -sSL https://install.python-poetry.org | sed 's/symlinks=False/symlinks=True/' | python3 -

Run Cookiecutter

  • Run cookiecutter command cookiecutter git@github.com:networktocode-llc/cookiecutter-ntc.git --directory nautobot
    • Answer the questions provided
  [1/13] codeowner_github_usernames (@github @usernames @of @repo @owners): @yournamehere
  [2/13] customer_name (Acme Corp): NTCU
  [3/13] customer_slug (ntcu):
  [4/13] customer_python (ntcu):
  [5/13] customer_camel (Ntcu):
  [6/13] project_slug (nautobot-ntcu):
  [7/13] project_python (nautobot_ntcu):
  [8/13] camel_name (NautobotNtcu):
  [9/13] github_org (networktocode-llc):
  [10/13] repo_url (https://github.com/networktocode-llc/nautobot-ntcu):
  [11/13] nautobot_version (1.5.9):
  [12/13] version (0.1.1):
  [13/13] Select production_environment
    1 - None
    2 - Docker Compose
    Choose from [1/2] (1): 2

Finish your local install

  • Open VS Code in the folder that was just created (should be nautobot-ntcu)
  • Copy environments/creds.example.env environments/creds.env
  • Install the current environment poetry install
  • Enter the current Environment poetry shell
  • Build the container invoke build
  • Start the web service invoke debug

Note: invoke debug allows you to view the logs and automatically restarts the web service, but holds up your command line, so please use an additional tab in these cases.