Home

PYRUST

Pyrust will be comprised of mylutils and some diagnostics programs, variations of diagnostics.py.

MYUTILS PACKAGE (PKG)

mylutils is a python package, written in Rust, that reads the same system files that utilities like PS, TOP and others read. Many of them are in the /proc folder.

DIAGNOSTICS.PY

This will be a python program that uses the mylutils package. The diagnostics.py will call the functions in mylutils to perform some basic diagnostics. This can evolved into a few versions:

• a salt module version.
• a version that can be run on the command line.
• a version to run inside a container or a VM.

Each version will differ on what functions of mylutils they call and how they use them to perform their diagnostics.

diagnostics.py will also read from prometheus node exporters.

Would you like to get involved?

Please consider contributing to this open source project, consider the following documents:

• Contributing
• Contributor Covenant Code of Conduct
• GNU General Public License v3.0

Basic steps:

1. Clone the project.
2. Write your code, include unit tests.
3. Submit a pull request.
4. Once approved, it will be merged to the main branch by one of the contributors

If you are contributing to mylutils package code, there are the following additional steps and considerations:

1. The unit tests for the mylutils packages, which is written in Rust, are python programs. The python unit test programs import the mylutils package and then test the functions by calling them. These tests are built on the python unit test class. They are in mylutils/unit_tests
2. You will probably use maturin to develop and test in your local sandbox. You will not be able to publish to pypi.org. Once your code is merged, one of the contributors will publish it there. Then it will be available by doing: pip install mylutils .

Would you like to become a contributor?

Please contact mayel.espino@gmail.com.

Any questions?

please contact: mayel.espino@gmail.com