Metadata-Version: 2.1
Name: STIM_Module
Version: 0.1.0
Summary: League of Legends STIM Module
Author-email: Jaxton 'Jax' Willman <jaxtonwillman@ufl.edu>, Benjamin 'Ben' Covert <benjamin.covert@ufl.edu>, David 'Sandy' Hutchins <davidhutchins@ufl.edu>
License: MIT License
        
        Copyright (c) 2022 Jaxton 'McCoolio II' Willman, Ben Covert, David 'Sandy' Hutchins
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://jaxjaxw.github.io/STIM_Module/index.html
Project-URL: Issues, https://github.com/ben-covert2020/STIM_Module/issues
Project-URL: Documentation, https://jaxjaxw.github.io/STIM_Module/documentation/index.html
Project-URL: Source Code, https://github.com/ben-covert2020/STIM_Module
Project-URL: Funding, https://www.patreon.com/jaxjaxw
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE.txt

# LOL STIM

## League of Legends Statistics Tracker and Improvement Manager
STIM is an app to use to help monitor and improve your LOL gameplay. Get it today!

<br/>

------------

<br/>

## USER GUIDE:

<br/>

### **For WINDOWS users**

#### Installing with pip:
```py -m pip install STIM_Module```

<br/>

#### Once the program is installed, run the program with:
```lolstats```

<br/>

#### Uninstall the package:
```py -m pip uninstall -y STIM_Module```

<br/>
<br/>

### **Windows Dev Commands from source code**

#### Build the project:
```py -m build```

<br/>

#### Upload to TestPyPi with Twine:
```twine upload --repository testpypi dist/*```

<br/>

#### Install from TestPyPI with pip:
```py -m pip install --index-url https://test.pypi.org/simple/ --no-deps STIM_Module```

<br/>

#### Upload to PyPi with Twine:
```twine upload dist/*```

<br/>

#### Quickly rebuild application to test code and CLI changes:
```py -m pip uninstall -y STIM_Module && py -m build && py -m pip install dist/STIM_Module-0.1.0-py3-none-any.whl```

<br/>

----------------

<br/>
<br/>

### **For UNIX/macOS users**

#### Installing with pip:
```python3 -m pip install STIM_Module```

<br/>

#### Once the program is installed, RUN the program with:
```lolstats```

<br/>

#### Uninstall the package:
```python3 -m pip uninstall -y STIM_Module```

<br/>

### **UNIX/macOS Dev Commands from source code**

#### Build the project
```python3 -m build```

<br/>

#### Upload to TestPyPi with Twine:
```twine upload --repository testpypi dist/*```

<br/>

#### Install from TestPyPI with pip:
```python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps STIM_Module```

<br/>

#### Upload to PyPi with Twine:
```twine upload dist/*```

<br/>

#### Quickly rebuild application to test code and CLI changes
```python3 -m pip uninstall -y STIM_Module && python3 -m build && python3 -m pip install dist/STIM_Module-0.1.0-py3-none-any.whl```

<br/>
<br/>
<br/>

## Also check the makefile for these common scripts



### DEV NOTES

For local script install, make sure to add this path in wsl

export PATH="$HOME/.local/bin:$PATH"


Using BumpVer to control automatic version numbers

Usage:

version_pattern = "MAJOR.MINOR.PATCH"


Automatic increment:
bumpver update {--major/--minor/--patch}

Do I need -n? Otherwise I have to log into GitHub

Add --dry to see what changes to make sure everything works, check pyproject.toml to ensure each file changes properly
