United Systems Core

United Systems Core is a system designed to simplify the process of creating, managing, and integrating Python packages for the Flask web framework. It is intended for managing IoT devices and creating various web services. The system follows the package-service principle, making it particularly convenient for developing applications with a microservices architecture.

Commands for controll

• install: Install a package from USCServer or GitHub.

  usc install package_name

  or

  usc install "https://github.com/autor/repo.git"

• import: Import a package from tar.gz file

  usc import "path/to/you.tar.gz"

• remove: Remove a package.

  usc remove package_name

• refresh: Refresh package data and install packages dependencies.

  usc refresh

• list: Get a list of installed packages.

  usc list
  

• python: For use python interpreter for usc.

  usc python -m pip list

• update: Update United Systems Core.

  usc update

• run: Start the server with all packages or only with selected ones.

  usc run

  usc run package_name, ...

  You can also install ignored packages at startup by adding the ignore keyword

  usc run ignore package_name, ...

• export: Export a package to the current folder opened in the terminal.

  usc export package_name, ...

• code: Open packages or a package in an IDE (VS Code, Vim).

  usc code

  or

  usc code package_name, ...

• templates: Open the templates folder.

  usc templates

• static: Open the static folder.

  usc static

• server: Set data for the server from which packages are downloaded.

  usc server <host:port>

• config: Set ip adress for the server on which the packages are launched.

  usc config 192.168.0.100

• -h: Get a help message.

• -v: Get USC version.

Install

• GIT

  git clone https://github.com/MrBrain-YT/United-Systems-Core.git

• Docker

  docker build -t usc .

  and

  docker run -t -d usc

How to create package

To create a package, you need to follow certain rules:

• You need to create a package template using a command

  usc create "package_name"

• Afterward, open the package in any available supported IDE (VS Code, Vim) using the command

  usc code "package_name"

  When you create a package, you will automatically create a python file with an example of the package home page

• After you have created a package template and started modifying it, you should follow certain rules:

  • The URL path to your package should ideally follow the pattern /package_name/... to avoid conflicts between different packages. Additionally, it's recommended to use the endpoint parameter following the pattern package_name_page_purpose. To specify the executable function when there are duplicate function names in different packages.

    @app.route('/package_name/...', methods = ['GET'], endpoint='package_name_appointment_page')

  • To add an HTML page, you need to open the "templates" directory using the command

    usc templates

    There, you need to find the directory of your package and place your HTML files in it. To use your HTML file in the render_template function, you need to specify the path as /package_name/test.html.

    return render_template("test/test.html")

• To add JS and CSS scripts, you can use the "static" folder in your package directory. To open the "static" directory, use the command:

  usc static

  Example usage in HTML:

  <link rel="stylesheet" type="text/css" href="/static/package_name/index.css">

• Any python files will automatically check during startup for the presence of the main function and whether it accepts the app argument. If an error is detected in your file, it will not be launched automatically and information about it will be displayed in the console. If your file does not have a main function, then it is considered auxiliary. The function launched through the run command must meet certain requirements:

  • It should accept the argument "app"

    def main(app:Flask):

  • It should run a function whose name is main

• To import custom modules, you should use the following structure:

  import packages.package_name.you_module

• In each package, there is a requirements.txt file that contains the necessary libraries for the package to function. These libraries are automatically downloaded when the package is installed or when the package list is refreshed using the refresh command. When a package is removed using the remove command, the associated libraries are also removed. If two packages use the same library, it's important to update the package list after removing a package to ensure that the list reflects the correct dependencies.

• If your USC package depends on another USC package, to automate the installation of all dependencies, you need to write the package name and its version (if it's crucial) using the format package_name==1.0.0 in the requirements.usc file located in your package.

• If you want to change the port on which your package will run, go to the package.ini file and change the port number. In the same file, you can configure the visibility of your package by modifying the status parameter. If its value is public, the package will be accessible on the public IP address set in the run.ini file. If the value is private, the service will run on localhost.

Running USC services

When you execute the run command, the service management console MicroConsole will be launched.

Commands MicroConsole:

• clear : Clear console

• edit : Edit package started in services (after edit need use reboot command)

  edit package_name

• exit : Stop processes and exit from MicroConsole

• help : Get help message

• list / ls : Get services info

• stats : Viewing complete information about all services

• reboot : Reboot service ( process )

  reboot 5

  or

  reboot *

• run : Run service ( process )

  run 5

  or

  run *

• stop : Stop service ( process )

  stop 5

  or

  stop *

Example package for USC

You can find an example package for USC at the following link: https://github.com/MrBrain-YT/test-usc-package

To download the package, use the command:

usc install https://github.com/MrBrain-YT/test-usc-package.git

Make a contribution

To contribute to this project, you can:

• Create packages.

• Write additions and fixes for USC and USCServer.

• connect to discord - https://discord.gg/zAmJG5apZK

Additional information

USCServer - https://github.com/MrBrain-YT/USCServer

test-usc-package - https://github.com/MrBrain-YT/test-usc-package