Skip to content

Commit

Permalink
Add docs and basic Python app config.
Browse files Browse the repository at this point in the history
  • Loading branch information
cofiem committed Jun 29, 2022
1 parent ac26b82 commit 587396e
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,6 @@ dmypy.json

# Pyre type checker
.pyre/

# JetBrains
.idea/
16 changes: 16 additions & 0 deletions README.md
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.
17 changes: 17 additions & 0 deletions docs/DEVELOP.md
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?
29 changes: 29 additions & 0 deletions pyproject.toml
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"

0 comments on commit 587396e

Please sign in to comment.