Skip to main content

A cross-platform library for creation, storage, management of commands and command packages. Execution of commands, parsing of files with command packages.

Project description

commandex v1.0.0

A cross-platform library for creation, storage, management of commands and command packages. Execution of commands, parsing of files with command packages.


Platform PyPI Downloads GitHub top language PyPI - Downloads GitHub release (latest by date) GitHub PyPI PyPI - Format GitHub Repo stars GitHub watchers GitHub forks


Description:

A cross-platform library for creation, storage, management of commands and command packages. Execution of commands, parsing of files with command packages.

  • Store the required commands under a given name in a simple file with a clear structure.
  • Read named command packages from a file.
  • Use only the required command packages from a file using filtering.
  • Execute command packages cross-platform.

How it works?

  1. Create a file with any name, with the extension * .cfg
  2. Use # as a comment, line break for convenience or separation.
  3. Use [package name] to specify the name of the command package.
  4. After the name, write the commands that you decided to combine under this name, one per line.
  5. To create the next batch of commands, use points 2, 3 again.
  6. Between commands, you can insert blank lines or comments, see point 2.

Used to create utilities for working with commands (execution, launch, autorun, storage).

You can keep your commands in simple and understandable files, collect them in one place, split into named categories (packages) and execute at any time:

The files must have the extension *.cfg, and have the correct structure:

commands.cfg:

# Comments

[package name 1]
command 1
command 2
command N

[package name 2]
command 1
command 2
command N

Help:

Install and Use:

  • pip install commandex

Available tools:

  • Pack - storing commands.
  • Command executors - command execution.
  • Pack makers - create a list with objects of command packages.
  • Parsers - parsers for files with command packages.
  • Filters - filtering commands.
  • Factories - Fabric for creating objects.

Principle of operation:

  • Reading command packages from a file.
  • Filter packages if needed.
  • We create a list of package objects for future use.
  • We execute commands from each package.

Simplest implementation:

from commandex import Commander

commander = Commander()
# Reading command packages from a file.
pack_dict = commander.parsers.cfg_parser.parse('file.cfg')
# Filter packages if needed.
packs = commander.filters.pack_filter.filter_pack_dict(pack_dict, add_list=[], exc_list=[])
# We create a list of package objects for future use.
pack_list = commander.makers.pack_maker.make_pack_list(packs)

# We execute commands from each package.
for pack in pack_list:
    print(pack.name)
    for command in pack.commands:
        print(command)
        commander.executors.os.execute(command)

Termux, Windows support:

Utilities created with use work "commandex", without problems in Termux, Windows.

For example: commandman.


Test coverage:

Run tests:

  • pip install pytest
  • pytest -v

Test coverage 100%

  • pip install pytest-cov
  • pytest --cov

commandex image

Report html:

  • pytest --cov --cov-report=html

⚠️ Disclaimer

By using this software, you agree to the full disclaimer terms.

Summary: Software provided "AS IS" without warranty. You assume all risks.

Full legal disclaimer: See DISCLAIMER.md


License

BSD 3-Clause License

Copyright (©) 2026, Alexander Suvorov


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commandex-1.0.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commandex-1.0.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file commandex-1.0.0.tar.gz.

File metadata

  • Download URL: commandex-1.0.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for commandex-1.0.0.tar.gz
Algorithm Hash digest
SHA256 33d606bace51e726863eed909e5290e4e00e883616b8a1218b027cad0e8d9098
MD5 85a40357bcae5015454d86e4e6bb2e98
BLAKE2b-256 f648dfee3cc896fc6958f7e458e9cbdd7f39aa0c2307a34e6bb75d5f73b63420

See more details on using hashes here.

File details

Details for the file commandex-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: commandex-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for commandex-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1f53006a86064895d81888e8aa9d3e765a0764daa675a528cd20f0e165161f4
MD5 d76196974a9441053388e4b483ac82a8
BLAKE2b-256 14463bcfc8c66066103871dde216b2bb43183f7de3f87fe167dd85627b0e5410

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page