diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..057f38a --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,59 @@ +# Installation of the script + +The following steps are required in order to install this script from the git archive. + +## Install virtual environment (only do this once) + +This should be done only once (unless you update the Python version). +Open a console in the folder of this script. +Call the command + +``` +python -m venv venv +``` + +This will create a local python instance in the local directory `venv`. + +## Enable the virtual environment + +**Important: This must be done every time you close you console.** +If you need to restart the console, just reissue these commands in the console. +Best is to keep the console open. + +The activation of the virtual environment depends in the OS used. + +### On Windows + +For activation under Windows, go to the root folder of the project if you are not yet there. +Call the script by + +``` +venv\Scripts\activate.bat +``` + +### On Linux + +For activation on Linux, go to the root folder of the project if you are not yet there. +Source the activation script by + +```bash +. ./venv/bin/activate +``` + +## Run the script + +You can now run the script locally. +The simplest way is to go into the `src` folder of the script (where the file `main.py` resides). +You can issue the command + +``` +python main.py --help +``` + +to get a list of CLI options. + +Normally you would call it with one parameter that is the folder name of a HTML export made by TopTurnier. + +``` +python main.py /path/to/HTML/export +``` diff --git a/requiremnts.txt b/requiremnts.txt index ae84fcc..dae88df 100644 --- a/requiremnts.txt +++ b/requiremnts.txt @@ -1,18 +1,29 @@ attrs==22.1.0 beautifulsoup4==4.11.1 +certifi==2023.7.22 +charset-normalizer==3.2.0 colorama==0.4.6 coloredlogs==15.0.1 coverage==6.5.0 debugpy==1.6.7 +distlib==0.3.7 exceptiongroup==1.0.1 humanfriendly==10.0 +idna==3.4 iniconfig==1.1.1 +Jinja2==3.1.2 +MarkupSafe==2.1.3 packaging==21.3 pluggy==1.0.0 +pynsist==2.8 pyparsing==3.0.9 pytest==7.2.0 pytest-cov==4.0.0 pytest-mock==3.10.0 +requests==2.31.0 +requests_download==0.1.2 soupsieve==2.3.2.post1 tabulate==0.9.0 tomli==2.0.1 +urllib3==2.0.5 +yarg==0.1.9 diff --git a/src/.gitignore b/src/.gitignore index 1bc5aa1..d7dc3e6 100644 --- a/src/.gitignore +++ b/src/.gitignore @@ -1 +1,2 @@ /.coverage +/build/ diff --git a/src/installer.cfg b/src/installer.cfg new file mode 100644 index 0000000..0345658 --- /dev/null +++ b/src/installer.cfg @@ -0,0 +1,41 @@ +[Application] +name=Solo Auswertung +version=0.9.0 +# How to launch the app - this calls the 'main' function from the 'myapp' package: +entry_point=main:main +# icon=myapp.ico +console=true + +[Python] +version=3.11.3 + +[Include] +# Packages from PyPI that your application requires, one per line +# These must have wheels on PyPI: +pypi_wheels = attrs==22.1.0 + beautifulsoup4==4.11.1 + colorama==0.4.6 + coloredlogs==15.0.1 + coverage==6.5.0 + debugpy==1.6.7 + exceptiongroup==1.0.1 + humanfriendly==10.0 + iniconfig==1.1.1 + packaging==21.3 + pluggy==1.0.0 + pyparsing==3.0.9 + pytest==7.2.0 + pytest-cov==4.0.0 + pytest-mock==3.10.0 + soupsieve==2.3.2.post1 + tabulate==0.9.0 + tomli==2.0.1 + +packages = solo_turnier + +# To bundle packages which don't publish wheels, or to include directly wheel files +# from a directory, see the docs on the config file. + +# Other files and folders that should be installed +# files = LICENSE +# data_files/