Welcome to utilities’ documentation!¶
pyutil¶
This repository houses a number of functional scripts I utilize to administer multiple workstations.
Installation¶
Python offers it’s users a large number of ways to install new packages.
One can install the python modules by:
Installing with pip
Install from newest dev version in master branch
pip install git+https://github.com/farisachugthai/utilities
Cloning with git and installing with pip
git clone git+https://github.com/farisachugthai/utilities
pip install .
As an alternative to a pip install, obtain the source code and run the setup.py file.
If you are on a Unix-like system, the following will ensure everything
below pyutil is in the environment variable $PATH
and give you the ability to modify the source code in place.
git clone https://github.com/farisachugthai/utilities
cd utilities
python3 setup.py build && python3 -m pip install -U -e .
After which point, the only necessary step will be ensuring that the scripts in sh are in your environment variable
$PATH.
# The script at pyutil/dlink.py is useful for creating symlinks for every
# file in a directory. If the directory ~/bin is in your path...
# Check which directories are in the ``$PATH`` env var
echo $PATH
# Then link the scripts in sh/ to a directory in your path!
python3 pyutil/dlink.py "$PWD/sh" "$HOME/bin"
For anyone using Windows 10, the PowerShell installation will be slightly different; however, not tremendously.
git clone https://github.com/farisachugthai/utilities
# `cd` is aliased to set-location for most instances of powershell;
# however in the interest of using domain specific built-ins:
Set-Location utilities
python3 setup.py build; python3 -m pip install -U -e .
# to view the environment variable path, run:
Get-ChildItem -Path $Env:PATH
# then ensure that the directory you pick is in your path, and run
python3 pyutil\dlink.py "$pwd\sh" C:\Users\path\to\directory
Note
When creating symbolic links on Windows, it’s necessary to start the console as an administrator. In addition, be aware that symlinks created in a bash subshell won’t be recognized as valid by Windows OS!
Building Documentation From Source¶
The documentation can be read online at GitHub Pages
However, the documentation can be built locally as well.
After following the installation instructions at root-installation, one can run
cd doc
make html
Then, direct your browser to _build/html/index.html.
To do so in a more direct manner, a htmlview target has been created as a convenience in the docs/Makefile.
This target will build the documentation and open up your default web browser automatically.
Testing¶
To run the tests with the interpreter available as python, use:
make test
If you want to explicitly define which interpreter, e.g. python3, use:
PYTHON=python3 make test
Alternatively, one can use distutils and the setup.py file like so:
python setup.py test
License¶
MIT
Contributing¶
Even though these are mostly scripts I’ve thrown together; I’d absolutely love any constructive criticism or pointers on how to get any module listed to work better!
I hope it goes without saying, but if it doesn’t, please don’t hesitate to fork or create an issue.
First we’ll start with the Backup Utilities.
