diff --git a/daemon/pyproject.toml b/daemon/pyproject.toml index 55bfabe4..2bea0b89 100644 --- a/daemon/pyproject.toml +++ b/daemon/pyproject.toml @@ -6,7 +6,14 @@ authors = ["Boeing Research and Technology"] license = "BSD-2-Clause" repository = "https://github.com/coreemu/core" documentation = "https://coreemu.github.io/core/" -include = ["core/gui/data/**/*", "core/configservices/*/templates"] +include = [ + "core/api/grpc/*", + "core/configservices/*/templates", + "core/constants.py", + "core/gui/data/**/*", +] +exclude = ["core/constants.py.in"] + [tool.poetry.dependencies] python = "^3.6" diff --git a/docs/install.md b/docs/install.md index 7b5014c4..d4ebf60f 100644 --- a/docs/install.md +++ b/docs/install.md @@ -74,11 +74,16 @@ sudo apt remove core ## Automated Installation -The automated install will install the various tools needed to help automate -the CORE installation (python3, pip, pipx, invoke, poetry). The script will -also automatically clone, build, and install the latest version of OSPF MDR. -Finally it will install CORE scripts and a systemd service, which have -been modified to use the installed poetry created virtual environment. +> **NOTE:** installing globally can have issues with dependency conflicts etc + +The automated install will install do the following: +* install base tools needed for installation + * python3, pip, pipx, invoke, poetry +* installs system dependencies for building core +* installs latest version of [OPSF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) +* installs core into poetry managed virtual environment or locally, if flag is passed +* installs scripts pointing to python interpreter being used +* installs systemd service, disabled by default After installation has completed you should be able to run the various CORE scripts for running core. @@ -92,10 +97,11 @@ git clone https://github.com/coreemu/core.git cd core # run install script -# script usage: install.sh [-d] [-v] +# script usage: install.sh [-v] [-d] [-l] [-p ] # # -v enable verbose install # -d enable developer install +# -l enable local install, not compatible with developer install # -p install prefix, defaults to /usr/local ./install.sh ``` @@ -117,16 +123,17 @@ After the installation complete it will have installed the following scripts. | Name | Description | |---|---| +| core-cleanup | tool to help removed lingering core created containers, bridges, directories | +| core-cli | tool to query, open xml files, and send commands using gRPC | | core-daemon | runs the backed core server providing TLV and gRPC APIs | | core-gui | runs the legacy tcl/tk based GUI | -| core-pygui | runs the new python/tk based GUI | -| core-cleanup | tool to help removed lingering core created containers, bridges, directories | | core-imn-to-xml | tool to help automate converting a .imn file to .xml format | +| core-manage | tool to add, remove, or check for services, models, and node types | +| core-pygui | runs the new python/tk based GUI | +| core-python | provides a convenience for running the core python virtual environment | | core-route-monitor | tool to help monitor traffic across nodes and feed that to SDT | | core-service-update | tool to update automate modifying a legacy service to match current naming | | coresendmsg | tool to send TLV API commands from command line | -| core-cli | tool to query, open xml files, and send commands using gRPC | -| core-manage | tool to add, remove, or check for services, models, and node types | ## Running User Scripts @@ -142,28 +149,57 @@ environment interpreter or to run a script within it. core-python