Gan's Utils

This is an installable python package for scripts I wrote for myself.

• PyPi Package Page link
• Documentation link

Installation

To install, simply run

$ pip install ganutils

To use the AI package, you will need to install PyTorch yourself.

Deployment

To deploy new versions to PyPi, change version number in setup.py and either

• create a new release for repo and GitHub workflow will automatically deploy it
• run python setup.py sdist and then twine upload dist/*.

Update Documentation

Currently, upon each new release, my GitHub action will automatically build and generate documentation necessary.

However, to manually generate documentation, I use pdoc3:

$ pip3 install pdoc3 # install dependency
$ pdoc3 --html ganutils # resulting docs will be in a new html/ folder

Dependencies

You'll need twine installed via pip and PyPi credentials set at $HOME/.pypirc