Fix .gitignore and reclaim the .yml configuration files!

.changelog/0.3.1.yml

@@ -0,0 +1,6 @@
+release_date: '2020-12-15'
+changes:
+- type: feature
+  component: general
+  description: Rearrange project structure
+  fixes: []

.gitignore

@@ -1,10 +1,3 @@
-# Created by .ignore support plugin (hsz.mobi)
-
-### yamal config files
-*.yml
-*.yaml
-
-### Python template
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -54,7 +47,6 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
 .hypothesis/
 .pytest_cache/
 
@@ -98,12 +90,8 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
@@ -135,5 +123,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-### JetBrains template
-.idea
+.idea

.readthedocs-custom-steps.yml

@@ -0,0 +1,3 @@
+
+steps:
+  - pydoc-markdown --build --site-dir $SITE_DIR -vv docs/pydoc-markdown.yml

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+
+mkdocs: {}  # tell readthedocs to use mkdocs
+
+python:
+  version: 3.7
+  install:
+  - method: pip
+    path: .
+  - requirements: docs/.readthedocs-requirements.txt

docs/pydoc-markdown.yml

@@ -0,0 +1,83 @@
+
+#@ def base_url():
+#@    if env.READTHEDOCS:
+#@      return "https://env-alias.readthedocs.io/en/" + env.READTHEDOCS_VERSION + "/"
+#@    else:
+#@      return None
+#@ end
+
+loaders:
+  - type: python
+    search_path: [../src]
+
+hooks:
+  pre-render:
+  - shut --cwd .. changelog -a --markdown > ../CHANGELOG.md
+
+processors:
+  - type: crossref
+  - type: filter
+    exclude_special: true
+    documented_only: true
+    exclude_private: true
+
+renderer:
+  type: hugo
+
+  markdown:
+    toc_maxdepth: 3
+    classdef_code_block: true
+    descriptive_class_title: false
+    signature_with_def: true
+    signature_with_decorators: false
+    signature_code_block: true
+    render_module_header: true
+    header_level_by_type:
+      Method: 3
+      Function: 3
+    source_linker:
+      type: github
+      repo: ndejong/arpwitch
+    source_format: '###### *[[view source]]({url})*'
+
+  config:
+    baseURL: #@ base_url()
+    title: arpwitch
+    theme: {clone_url: "https://github.com/alex-shpak/hugo-book.git"}
+
+  build_directory: docs/build
+  content_directory: content/docs # The "alex-shpak/hugo-book" theme only renders pages in "content/docs" into the nav.
+  default_preamble: {menu: main}
+
+  pages:
+
+    - title: Home
+      preamble:
+        weight: 10
+      name: index
+      source: ../README.md
+      directory: '..'
+
+    - title: Project
+      preamble:
+        weight: 40
+      name: project
+      source: project.md
+
+    - title: Changelog
+      preamble:
+       weight: 50
+      name: changelog
+      source: ../CHANGELOG.md
+
+    - title: Development
+      preamble:
+        weight: 60
+      name: development
+      source: development.md
+
+    - title: License
+      preamble:
+        weight: 70
+      name: license
+      source: ../LICENSE

package.yml

@@ -0,0 +1,37 @@
+
+name: arpwitch
+version: 0.3.2
+author: Nicholas de Jong <contact@nicholasdejong.com>
+license: BSD2
+description: A modern arpwatch replacement with JSON formatted outputs and easy options to exec commands when network changes are observed.
+url: https://arpwitch.readthedocs.io/
+
+typed: false
+
+entrypoints:
+  console_scripts:
+    - arpwitch = arpwitch.cli.entrypoints:arpwitch
+
+test-driver:
+  type: pytest
+
+requirements:
+  - python ^3.6
+  - scapy[basic]
+  - psutil
+  - ouilookup
+
+classifiers:
+  - "Environment :: Console"
+  - "Intended Audience :: System Administrators"
+  - "Intended Audience :: Information Technology"
+  - "Topic :: System :: Networking :: Monitoring"
+  - "Programming Language :: Python :: 3"
+  - "License :: OSI Approved :: BSD License"
+
+keywords:
+  - 'arpwitch'
+  - 'arpwatch'
+  - 'arp'
+  - 'network'
+  - 'security'