A collection of scripts written in python to do some day-to-day tasks. This is a number of scripts that can be used to automate some common tasks on the PC. I use them in Windows, so they are not really tested to work on linux.
Some of the scripts have settings embedded in the script, such as folders where to store the information, etc. I may think about moving these settings outside, in .ini files or similar, so that they can be easily updated, and even used on linux.
You can install the scripts by creating a virtual environment, using the requirements file provided. This can be done using venv as follows:
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
If you are on linux, activate the environment using the following command:
source .venv\bin\activate
Once the environment is activated, you can run each script by using:
python scripts/<name>.py args
For each script, there is a --help argument that can be requested to provide a description of the arguments and options to be used.
To launch the graphical environment, use the following command:
python gui_qt/main.py
I'm using cx_freeze to compile the scripts into executable files, that I can then place in my windows PC on a folder in the path, and run them from the command line. cx_freeze is included in the requirements.txt file. I need to compile the code from the folder where the scripts are located. The file setup.py contains the configuration, and the compilation of files can be launched as follows:
cd scripts
python setup.py build
This will create a folder build, with the executable for all scripts. You can move this folder to wherever you want on your PC, and run the scripts without need of python.
Testing is not yet complete. But you can run all tests by running the command:
pytest
The config file pytest.ini contains the parameters to run the tests. If you want to see a coverage report, you can run:
coverage run
coverage html
And you get the html report to see the coverage of the programs.
This project is using an MIT license.