-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs and basic Python app config.
- Loading branch information
Showing
4 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -127,3 +127,6 @@ dmypy.json | |
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# JetBrains | ||
.idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" |