system-cross

system-cross is a cross system utilities libary. It works across all major operating systems and has lots of features.

Compatibility

🟩 (Works perfectly); 🟨 (Untested); 🟧 (Some Issues); 🟥 (Unusable)

Features

• Easy to use for beginners, but not lacking for experts
• Efficient
• Fully cross-platform
• Regular updates and support
• Comprehensive documentation

Installation

You can install system-cross via pip:

pip install system-cross --pre --upgrade

Or clone the repository and install manually:

git clone https://github.com/Adalfarus/system-cross.git
cd system-cross
python -m pip install .

If you have problems with the package please use py -m pip install system-cross[cli,dev] --pre --upgrade --user

📦 Usage

Here are a few quick examples of how to use system-cross.

TODO

locker cli

Can currently run tests with locker tests run tests/ -minimal and show a basic help using locker help.

For more detailed usage and examples, check out our documentation.

Naming convention, dependencies and library information

PEP 8 -- Style Guide for Python Code

For modules I use 'lowercase', classes are 'CapitalizedWords' and functions and methods are 'lower_case_with_underscores'.

Contributing

We welcome contributions! Please see our contributing guidelines for more details on how you can contribute to system-cross.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

Aps Build master

You can use the aps_build_master script for your os to make your like a lot easier. It supports running tests, installing, building and much more as well as chaining together as many commands as you like.

This example runs test, build the project and then installs it

call .\aps_build_master.bat 234

sudo apt install python3-pip
sudo apt install python3-venv
chmod +x ./aps_build_master.sh
./aps_build_master.sh 234

License

system-cross is licensed under the LGPL-2.1 License - see the LICENSE file for details.