README.md

ChimeraScript

A suit of Python scripts for my everyday usage

This project contains a list of simple but useful Python scripts. Most of them are used to automate boring or repetitive tasks (e.g. backup to a remote location).

The majority the script available in this repository are born from my necessities but the hope for the future of the project is to become a go-to spot to find quick and easy automation solution to everyday problems.

Installation

While a requirements.txt is provided in the project and can be used to install all the needed dependencies, is advised to use Poetry instead to manage the project dependencies since its better functionalities and its more complete with respect to pip.

To install and run a script with pip, simply type in your terminal

  pip3 install -r requirements.txt
  python3 scripts/GitPuller.py ...

To install the dependencies and run the scripts with poetry, use:

  poetry install # Installs dependency with poetry package manager

  poetry run python3 scripts/GitPuller.py ... # Basic script execution

  chmod +x scripts/*.py # Alternatively, you can set the scripts as executables
  poetry run scripts/GitPuller.py # Then simply do...

Running Tests

Each scripts has its own test suite in the tests folder, the test are run with pytest.

To run the full test suite of every script simply type:

  poetry run pytest

while to run one or more specific test suites, specify the one desired as in the example:

  poetry run pytest tests/test_gitpuller.py

Acknowledgements

• Poetry
• Pytest
• Pytube
• Rich
• readme.so

Authors

• @its-hmny Follow me on Twitter as well

License

This project is distributed under the GPLv3 license.