Skip to content

Commit

Permalink
clean up files and update version tracker
Browse files Browse the repository at this point in the history
  • Loading branch information
mlataza committed Jan 20, 2025
1 parent 8f05590 commit a39214c
Show file tree
Hide file tree
Showing 12 changed files with 167 additions and 144 deletions.
3 changes: 0 additions & 3 deletions MANIFEST.in

This file was deleted.

38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
# rewst_remote_agent

[![Unit Tests](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/unit-tests.yml) [![Code Coverage](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/coverage.yml/badge.svg)](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/coverage.yml)

An RMM-agnostic remote agent using the Azure IoT Hub

Goals:
* Run as an service on Windows (Linux / Mac coming later!)
* Provisioning (Windows):
* `iwr ((irm {{ github_release_url }}).assets|?{$_.name -eq "rewst_agent_config.win.exe"}|select -exp browser_download_url) -OutFile rewst_agent_config.win.exe`
* Downloads latest release of configuration Utility from GitHub
* `.\rewst_agent_config.win.exe` `--config-url` _{ Your Trigger URL }_ `--config-secret` _{ Your global config secret }_ `--org-id` _{ customer organization id }_
* Initiates configuration and installation of the agent
* `config-url`: The configured workflow trigger from the Crate installation
* `config-secret`: Stored in an Org variable under your company. If it changes, existing installations will still work, but new commands to install it will need the new secret.
* `org-id`: The organization's (your customer) Rewst Org ID.
* Operation:
* Stays resident and connected to the IoT Hub
* Rewst workflows can send an object to IoT hub that contains a list of `commands`
* When the list arrives, the script will spawn shell process and process these commands sequentially within the _same_ environment
* Each command will have its output collected and returned back in a list of `command_results` that is in the same index as the command from `commands`
* Handle disconnects gracefully and restart
# Agent Smith

[![Unit Tests](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/unit-tests.yml)
[![Code Coverage](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/coverage.yml/badge.svg)](https://github.com/RewstApp/rewst_remote_agent/actions/workflows/coverage.yml)

Rewst's lean, open-source command executor that fits right into your Rewst workflows.

## Documentation

See [Community Page](https://docs.rewst.help/community-corner/agent-smith) for full details.

## Contributing

Contributions are always welcome. Please submit a PR!

## License

Agent Smith is licensed under `GNU GENERAL PUBLIC LICENSE`. See license file for details.
40 changes: 0 additions & 40 deletions TODO.md

This file was deleted.

19 changes: 18 additions & 1 deletion __version__.py
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
__version__ = '0.6.101'
""" Version tracking module """

import subprocess

def get_poetry_version() -> str|None:
"""
Get poetry version from poetry file.
Returns:
str|None: poetry version string if successful, otherwise None
"""
try:
version = subprocess.check_output(["poetry", "version", "--short"], text=True).strip()
return version
except subprocess.CalledProcessError:
return None

__version__ = get_poetry_version()
28 changes: 0 additions & 28 deletions architecture.md

This file was deleted.

File renamed without changes.
130 changes: 128 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions poetry.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[virtualenvs]
in-project = true
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[project]
name = "rewst_remote_agent"
version = "0.6.101"
version = "0.6.102"
description = "An RMM-agnostic remote agent using the Azure IoT Hub"
authors = [
{name = "tim-at-rewst", email = "[email protected]"}
]
readme = "README.md"
requires-python = ">=3.12,<4"
requires-python = ">=3.12,<3.14"
dependencies = [
"psutil (>=6.1.1,<7.0.0)",
"platformdirs (>=4.3.6,<5.0.0)",
Expand All @@ -26,4 +26,4 @@ pytest-asyncio = "^0.25.2"
pytest-mock = "^3.14.0"
coverage-lcov = "^0.3.0"
pytest-cov = "^6.0.0"

pyinstaller = "^6.11.1"
Binary file removed requirements.txt
Binary file not shown.
11 changes: 0 additions & 11 deletions rewst_agent_config.md

This file was deleted.

34 changes: 0 additions & 34 deletions setup.py

This file was deleted.

0 comments on commit a39214c

Please sign in to comment.