diff --git a/.gitignore b/.gitignore index b6e4761..7e25864 100644 --- a/.gitignore +++ b/.gitignore @@ -127,3 +127,6 @@ dmypy.json # Pyre type checker .pyre/ + +# JetBrains +.idea/ diff --git a/README.md b/README.md index e321f7d..c0ad47f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # server-monitor-agent + A simple Python application for running checks on a server and sending formatted notifications. + +This program is an agent that can be run on server instances. +It provides a number of commands to do common tasks. + +## Commands + +### Check + +Gather information about the instance and report the result via +exit code and json-formatted output. + +### Notify + +Send a message to an alerting service. +One message contains details about one service. diff --git a/docs/DEVELOP.md b/docs/DEVELOP.md new file mode 100644 index 0000000..0918723 --- /dev/null +++ b/docs/DEVELOP.md @@ -0,0 +1,17 @@ +# Development + +This document outlines the development process. + + +## Set up the local development environment + +TODO: +- Uses pipenv and Pipfile to manage Python packages? + + +## Build and publish a new release + +TODO: +- process? +- automated via github actions, circleci? +- Installed via a pip wheel or self-contained binary? diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..43475c5 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,29 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "server-monitor-agent" +version = "0.0.1" +authors = [ + { name="Mark" }, +] +maintainers = [ + { name="Mark" }, +] +description = "A simple Python application for running checks on a server and sending formatted notifications." +readme = "README.md" +license = { file="LICENSE" } +requires-python = ">=3.9" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: POSIX :: Linux", + "Development Status :: 2 - Pre-Alpha", + "Intended Audience :: System Administrators", + "Topic :: System :: Monitoring", +] + +[project.urls] +"Homepage" = "https://github.com/qcif/server-monitor-agent" +"Bug Tracker" = "https://github.com/qcif/server-monitor-agent/issues"