💻 System Module

The System module provides a collection of utilities for interacting with the operating system. It includes commands, directories, files, environment variables, paths, processes and operating system information.

🚀 Quick Example

Execute a shell command.

import allkitpy

result = allkitpy.system.command.run(
    "python --version"
)

print(result["stdout"])

Python 3.13.5

📚 Functions

⚙️ command.run()

Execute a shell command and return its output.

import allkitpy

result = allkitpy.system.command.run(
    "dir"
)

print(result["stdout"])

Directory listing...

📁 directory.create()

Create a new directory. Parent folders are created automatically if needed.

import allkitpy

allkitpy.system.directory.create(
    "Projects"
)

Projects/

🗑️ directory.remove()

Delete a directory and all of its contents.

import allkitpy

allkitpy.system.directory.remove(
    "Projects"
)

Projects removed

📂 directory.list()

Return the names of files and folders inside a directory.

import allkitpy

items = allkitpy.system.directory.list(
    "Documents"
)

print(items)

[
    "notes.txt",
    "report.pdf",
    "images",
    "backup"
]

🌱 env.get()

Retrieve the value of an environment variable.

import allkitpy

username = allkitpy.system.env.get(
    "USERNAME"
)

print(username)

John

⚙️ env.set()

Create or update an environment variable for the current Python process.

import allkitpy

allkitpy.system.env.set(
    "APP_MODE",
    "Development"
)

Environment variable updated

📋 env.all()

Return all available environment variables as a dictionary.

import allkitpy

variables = allkitpy.system.env.all()

print(variables)

{
    "PATH": "...",
    "USERNAME": "John",
    "TEMP": "C:\\Temp",
    ...
}

📄 file.create()

Create an empty file.

import allkitpy

allkitpy.system.file.create(
    "notes.txt"
)

notes.txt created

🗑️ file.remove()

Delete a file if it exists.

import allkitpy

allkitpy.system.file.remove(
    "notes.txt"
)

notes.txt removed

💻 os.system()

Return the name of the current operating system.

import allkitpy

print(
    allkitpy.system.os.system()
)

Windows

🖥️ os.release()

Return the operating system release.

import allkitpy

print(
    allkitpy.system.os.release()
)

11

🧩 os.version()

Return the detailed version of the current operating system.

import allkitpy

version = allkitpy.system.os.version()

print(version)

10.0.26100

🖥️ os.machine()

Return the machine architecture of the current computer.

import allkitpy

machine = allkitpy.system.os.machine()

print(machine)

AMD64

⚡ os.processor()

Return information about the processor being used.

import allkitpy

cpu = allkitpy.system.os.processor()

print(cpu)

Intel64 Family 6 Model 165

🐍 os.python_version()

Return the version of Python currently running your program.

import allkitpy

print(
    allkitpy.system.os.python_version()
)

3.13.5

📂 path.exists()

Check whether a file or directory exists.

import allkitpy

exists = allkitpy.system.path.exists(
    "report.pdf"
)

print(exists)

True

📍 path.absolute()

Return the absolute path of a file or directory.

import allkitpy

path = allkitpy.system.path.absolute(
    "report.pdf"
)

print(path)

C:\Users\User\Documents\report.pdf

📁 path.parent()

Return the parent directory of a file or folder.

import allkitpy

parent = allkitpy.system.path.parent(
    "Documents/report.pdf"
)

print(parent)

Documents

📄 path.filename()

Return the filename from a file path.

import allkitpy

name = allkitpy.system.path.filename(
    "Documents/report.pdf"
)

print(name)

report.pdf

🏷️ path.extension()

Return the extension of a file.

import allkitpy

ext = allkitpy.system.path.extension(
    "report.pdf"
)

print(ext)

.pdf

🆔 process.pid()

Return the Process ID (PID) of the current Python process.

import allkitpy

pid = allkitpy.system.process.pid()

print(pid)

15428

📂 process.cwd()

Return the current working directory of the running Python process.

import allkitpy

cwd = allkitpy.system.process.cwd()

print(cwd)

C:\Users\User\Projects\AllkitPy

📘 Module Summary

The System module provides convenient access to common operating system features through a clean, consistent API. It helps you work with files, directories, paths, environment variables, processes, shell commands, and operating system information without needing to remember multiple standard library modules.