Metadata-Version: 2.1
Name: ganutils
Version: 2.2
Summary: This is an installable python package for scripts I wrote for myself.
Home-page: https://github.com/Michael-Tu/ganutils
Author: Gan Tu
Author-email: tugan0329@gmail.com
License: MIT
Description: # Gan's Utils
        
        ![Auto Release Badge](https://github.com/Michael-Tu/ganutils/workflows/Auto%20Release/badge.svg) ![PyPi Publish Badge](https://github.com/Michael-Tu/ganutils/workflows/Publish%20PyPi%20Package/badge.svg) ![Issues Labeler Badge](https://github.com/Michael-Tu/ganutils/workflows/Issues%20Labeler/badge.svg)
        
        This is an installable python package for scripts I wrote for myself.
        
        - PyPi Package Page [link](https://pypi.org/project/ganutils/)
        - Documentation [link](https://michael-tu.github.io/ganutils/)
        
        ## Installation
        
        To install, simply run
        
        ```
        $ pip install ganutils
        ```
        
        To use the AI package, you will need to install [PyTorch](https://pytorch.org/get-started/locally/) 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](https://pdoc3.github.io):
        
        ```
        $ 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`](https://docs.python.org/3.3/distutils/packageindex.html#pypirc)
        
Keywords: tugan,utils,tools
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
