Add app v1.1 template and initial project tooling

nautobot · Aug 25, 2023 · 29dae0e · 29dae0e
commit 29dae0e
Show file tree

Hide file tree

Showing 109 changed files with 5,578 additions and 0 deletions.
diff --git a/.flake8 b/.flake8
@@ -0,0 1,4 @@
 [flake8]
 # E501: Line length is enforced by Black, so flake8 doesn't need to check it
 # W503: Black disagrees with this rule, as does PEP 8; Black wins
 ignore = E501, W503
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 1,9 @@
 # These owners will be the default owners for everything in the repo.
 # Unless a later match takes precedence, these will be requested for
 # review when someone opens a pull request. Once approved, PR creators
 # are encouraged to merge their own PRs.
 
 # Order is important; the last matching pattern takes the most
 # precedence.
 
 # * @team
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 1,26 @@
 ---
 name: 🐛 Bug Report
 about: Report a bug
 ---
 
 ### Environment
 
 * Python version: <!-- Example: 3.7.7 -->
 * cookiecutter-nautobot-app template version: <!-- Example: 1.0.0 -->
 
 <!-- What happened instead? -->
 ### Observed Behavior
 
 <!-- What did you expect to happen? -->
 ### Expected Behavior
 
 <!--
  Describe in detail the exact steps that someone else can take to reproduce
  this bug using the current release.
 -->
 ### Steps to Reproduce
 
 1.
 2.
 3.
 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 1,22 @@
 ---
 name: ✨ Feature Request
 about: Propose a new feature or enhancement
 
 ---
 
 ### Environment
 
 * cookiecutter-nautobot-app version: <!-- Example: 1.0.0 -->
 
 <!--
  Describe in detail the new functionality you are proposing.
 -->
 ### Proposed Functionality
 
 <!--
  Convey an example use case for your proposed feature. Write from the
  perspective of a user who would benefit from the proposed
  functionality and describe how.
 --->
 ### Use Case
 
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 1,11 @@
 ## New Pull Request
 
 Have you:
 
 - [ ] Updated the README if necessary?
 - [ ] Updated any configuration settings?
 
 
 ## Change Notes
 
 ## Justification
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 1,2 @@
 ---
 # name: "CI"
diff --git a/.gitignore b/.gitignore
@@ -0,0 1,129 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
 # C extensions
 *.so
 
 # Distribution / packaging
 .Python
 build/
 develop-eggs/
 dist/
 downloads/
 eggs/
 .eggs/
 lib/
 lib64/
 parts/
 sdist/
 var/
 wheels/
 pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
 
 # PyInstaller
 # Usually these files are written by a python script from a template
 # before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
 
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
 .tox/
 .nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
 *.py,cover
 .hypothesis/
 .pytest_cache/
 
 # Translations
 *.mo
 *.pot
 
 # Django stuff:
 *.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
 
 # Flask stuff:
 instance/
 .webassets-cache
 
 # Scrapy stuff:
 .scrapy
 
 # Sphinx documentation
 docs/_build/
 
 # PyBuilder
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
 # IPython
 profile_default/
 ipython_config.py
 
 # pyenv
 .python-version
 
 # pipenv
 # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 # However, in case of collaboration, if having platform-specific dependencies or dependencies
 # having no cross-platform support, pipenv may install dependencies that don't work, or not
 # install all needed dependencies.
 #Pipfile.lock
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 
 # Celery stuff
 celerybeat-schedule
 celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
 # Environments
 .env
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
 
 # Spyder project settings
 .spyderproject
 .spyproject
 
 # Rope project settings
 .ropeproject
 
 # mkdocs documentation
 /site
 
 # mypy
 .mypy_cache/
 .dmypy.json
 dmypy.json
 
 # Pyre type checker
 .pyre/
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -0,0 1,14 @@
 ---
 extends: "default"
 rules:
  comments: "enable"
  empty-values: "disable"
  indentation:
  indent-sequences: "consistent"
  line-length: "disable"
  quoted-strings:
  quote-type: "double"
 ignore: |
  .venv/
  nautobot-app/{{ cookiecutter.project_slug }}/invoke.mysql.yml
  nautobot-app/{{ cookiecutter.project_slug }}/invoke.example.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 1,10 @@
 # CONTRIBUTING
 
 To contribute follow primarily the git flow:
 
 1. Open an issue
 2. If working on the issue, assign the issue to yourself
 3. Open a PR
 4. Get approval from the CODEOWNERS for each directory, which **should** be auto added
 5. Once approval has been gained, the originator of the PR is to merge the PR into main
 6. Once the PR is merged, delete the branch