https://github.com/farisachugthai/utilities

Functional scripts to administer multiple workstations.
https://github.com/farisachugthai/utilities

backups conda multiple-workstations neovim python3 rclone requests sphinx termux tmux youtube-dl

Last synced: about 2 months ago
JSON representation

Functional scripts to administer multiple workstations.

• Host: GitHub
• URL: https://github.com/farisachugthai/utilities
• Owner: farisachugthai
• License: mit
• Created: 2018-05-31T06:06:04.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T05:52:28.000Z (almost 2 years ago)
• Last Synced: 2024-05-19T23:35:38.897Z (4 months ago)
• Topics: backups, conda, multiple-workstations, neovim, python3, rclone, requests, sphinx, termux, tmux, youtube-dl
• Language: Python
• Homepage: https://farisachugthai.github.io/utilities/
• Size: 7.2 MB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. _root-readme:

======

pyutil

======

.. module:: readme

.. title:: utilities

.. highlight:: sh

This repository houses a number of functional scripts I utilize to

administer multiple workstations.

.. contents: Table of Contents

    :local:

    :backlinks: "entry"

.. _root-installation:

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

.. code-block:: sh

    pip install git+https://github.com/farisachugthai/utilities

* Cloning with git and installing with pip

.. code-block:: sh

    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.

.. _`setup.py`: setup.py

If you are on a Unix-like system, the following will ensure everything

below pyutil_ is in the environment variable :envvar:`$PATH`

and give you the ability to modify the source code in place.

.. _pyutil: ./pyutil/

.. code-block:: sh

    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 :envvar:`$PATH`.

.. _sh: ./sh/

.. code-block:: sh

    # 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.

.. code-block:: console

    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!

.. _root-docs:

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

.. code-block:: shell

   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`_.

.. _`docs/Makefile`: ./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:

.. code-block:: console

    make test

If you want to explicitly define which interpreter, e.g. ``python3``, use:

.. code-block:: console

    PYTHON=python3 make test

Alternatively, one can use :mod:`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.

.. _`Back up directories.`: docs/api/pyutil/backup_nt_and_posix

.. _`Automate the process of downloading plain-text files from the Internet.`: pyutil/lazy_downloader.py

.. _`Automate downloading videos from YouTube.`: pyutil/yt_dl.py

.. _`Symlink files recursively`: pyutil/linktree.py

.. _`Inspect varying python modules.`: pyutil/inspect_module.py

.. _`Introspect environment variables.`: pyutil/env.py

.. _`Profiling nvim startup time.`: pyutil/nvim_profiling.py

.. _`Strip trailing whitespace from a file.`: pyutil/strip_space.py

.. _`setup.py`: setup.py