Merge branch 'master' into feature/smallerDockerBaseImage

Author: white-gecko

.github/workflows/build.yml

@@ -39,7 +39,6 @@ jobs:
              git config --global user.name "Quit CI Tests"
       - name: Run Tests
         run: |
-             poetry run coverage run -a --source=quit tests/test_app.py
              poetry run coverage run -a --source=quit tests/test_app.py
              poetry run coverage run -a --source=quit tests/test_cache.py
              poetry run coverage run -a --source=quit tests/test_conf.py

README.md

@@ -28,7 +28,7 @@ To get the Quit Store you have three options:
 
 ### Installation from Source
 
-Install [pip](https://pypi.python.org/pypi/pip/) and optionally [virtualenv resp. virtualenvwrapper](http://virtualenvwrapper.readthedocs.io/en/latest/install.html) (`pip install virtualenvwrapper`).
+Install [poetry](https://python-poetry.org/).
 
 Get the Quit Store source code:
 ```
@@ -37,14 +37,8 @@ $ cd QuitStore
 ```
 If you are using virtualenvwrapper:
 ```
-$ mkvirtualenv -p /usr/bin/python3 -r requirements.txt quit
-$ workon quit # this has to be executed befor you use quit store
-…
-$ deactivate # this can be used after you are done with quit and want to get back your “normal” environment
-```
-If you are not using virtualenvwrapper:
-```
-$ pip install -r requirements.txt
+$ poetry install
+$ poetry run quitstore --help
 ```
 
 ### Git configuration
@@ -53,8 +47,10 @@ Configure your name and email for Git.
 This information will be stored in each commit you are creating with Git and the Quit Store on your system.
 It is relevant so people know which contribution is coming from whom. Execute the following command if you haven't done that before.
 
-    $ git config --global user.name "Your Name"
-    $ git config --global user.email "you@e-mail-provider.org"
+```
+$ git config --global user.name "Your Name"
+$ git config --global user.email "you@e-mail-provider.org"
+```
 
 ### Start with Existing Data (Optional)
 
@@ -88,7 +84,7 @@ $ ./quit -t /path/to/repo
 
 If you have it installed from the sources:
 ```
-$ quit/run.py -t /path/to/repo
+$ poetry run quitstore -t /path/to/repo
 ```
 
 Open your browser and go to [`http://localhost:5000/`](http://localhost:5000/).
@@ -141,6 +137,8 @@ The log level for the logfile is always extra verbose (DEBUG).
 
 ## Configuration File
 
+*deprecated* (we plan to remove the configuration file feature)
+
 If you want to work with configuration files you can create a `config.ttl` file.
 This configuration file consists of two parts, the store configuration and the graph configuration.
 The store configuration manages everything related to initializing the software, the graph configuration maps graph files to their graph IRIs.
@@ -253,6 +251,30 @@ Further options which can be set are:
 * `QUIT_OAUTH_CLIENT_ID` - the GitHub OAuth client id (for OAuth see also the [github docu](https://developer.github.com/apps/building-oauth-apps/authorization-options-for-oauth-apps/))
 * `QUIT_OAUTH_SECRET` - the GitHub OAuth secret
 
+## Run the Tests
+
+You need to have the quitstore installed from source, see section [Installation from Source](#installation-from-source).
+
+```
+poetry run pytest
+```
+
+## Troubleshooting
+
+### Use on Windows with restricted permissions
+
+On Windows you might not be able to download the `.exe` file directly.
+If so, use the `curl` command in the power shell.
+
+When you start the QuitStore (e.g. with `quit.exe -t .`) it will try to open a port that is available from outside, which will require permission by the administrator user.
+To open the port only locally you should start the QuitStore with:
+
+```
+quit.exe -t . -h localhost
+```
+
+The default port is `5000` (`http://localhost:5000/`).
+
 ## Migrate from old Versions
 
 ### Update to 2018-11-20 from 2018-10-29 and older
@@ -272,7 +294,7 @@ git commit -m "Migrate from nq to nt"
 
 ## License
 
-Copyright (C) 2017 Norman Radtke <http://aksw.org/NormanRadtke> and Natanael Arndt <http://aksw.org/NatanaelArndt>
+Copyright (C) 2017-2022 Norman Radtke <http://aksw.org/NormanRadtke>, Natanael Arndt <http://aksw.org/NatanaelArndt>, and contributors
 
 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 

poetry.lock

@@ -18,6 +18,8 @@ uWSGI = "^2.0.20"
 [tool.poetry.dev-dependencies]
 pylava = "^0.3.0"
 coveralls = "^3.3.1"
+pytest = "^6.2.5"
+pytest-cov = "^3.0.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -124,6 +124,12 @@ def getDefaultBranch(self):
         repository_current_head = self.repository.current_head
         if repository_current_head:
             return repository_current_head
+        try:
+            git_config_default_branch = pygit2.Config.get_global_config()['init.defaultBranch']
+            if git_config_default_branch:
+                return git_config_default_branch
+        except KeyError:
+            pass
         return "master"
 
     def rebuild(self):