Merge branch 'main' of github.com:TUBAF-IFI-DiPiT/github2pandas into main

Author: SebastianZug

README.md

@@ -46,14 +46,63 @@ The internal structure and relations of the data frames are included in the proj
 
 `github2pandas` is available on [pypi](https://pypi.org/project/github2pandas/). Use pip to install the package.
 
+### global
+
+On Linux:
+
+```
+sudo pip3 install github2pandas 
+sudo pip install github2pandas
+```
+
+On Windows as admin or for one user:
+
 ```
-sudo pip3 install github2pandas
+pip install github2pandas
+pip install --user github2pandas 
 ```
 
-## Application  
+### in virtual environment:
+
+```
+pipenv install github2pandas
+```
+
+## Usage  
 
 GitHub token is required for use, which is used for authentication. The [website](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) describes how you can generate this for your GitHub account. Customise the username and project name and explore any public or private repository you have access to with your account!
 
+Access token is to define in `.env` oder `.py (.ipynb)` file. The default value of python.envFile setting is `${workspaceFolder}/.env`
+
+```
+TOKEN="example_token"
+```
+
+An short example of a python script:
+
+```
+import os
+
+from github2pandas.issues import Issues
+from github2pandas.utility import Utility
+from pathlib import Path
+
+git_repo_name = "github2pandas"
+git_repo_owner = "TUBAF-IFI-DiPiT"
+    
+default_data_folder = Path("data", git_repo_name)
+github_token = os.environ['TOKEN']
+
+repo = Utility.get_repo(git_repo_owner, git_repo_name, github_token, default_data_folder)
+Issues.generate_issue_pandas_tables(repo, default_data_folder)
+issues = Issues.get_issues(default_data_folder,Issues.ISSUES)
+
+# List the last 14 issue entries
+issues.head(14)
+```
+
+## Notebook examples
+
 The corresponding [github2pandas_notebooks](https://github.com/TUBAF-IFI-DiPiT/github2pandas_notebooks/blob/main/README.md) repository illustrates the usage with examplary investigations.
 
 The documentation of the module is available at [https://github2pandas.readthedocs.io/](https://github2pandas.readthedocs.io/).

docs/changes.rst

@@ -115,4 +115,9 @@ Version 1.1.15 (July 30, 2021)
 -----------------------------------
 * define unknown user in Version works now only for one user
 * if a anonym_uuid is known from a different repository for this unknown user then this anonym uuid will be extract_user_data
-* The same unknown Author name will be connected to the same anonym_uuid
+* The same unknown Author name will be connected to the same anonym_uuid
+
+Version 1.1.17 (November 11, 2021)
+-----------------------------------
+* add output for crashed git pull operatins
+* fix empty repositories

github2pandas/__init__.py

@@ -1 +1 @@
-__version__ = '1.1.15'
+__version__ = '1.1.17'