Merge branch 'main' of https://github.com/Kataglyphis/WebDavClient

.github/workflows/pages.yml

@@ -3,7 +3,7 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Deploy web page with sphinx
+name: Test WebDavClient + Deploy web page
 
 on:
   push:
@@ -15,21 +15,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 🚚 Get latest code
-        uses: actions/checkout@v4.1.7
+        uses: actions/checkout@v4.2.0
       - name: Set up Python 3.11
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: "3.11"
       # You can test your matrix by printing the current Python version
       - name: Setup python env
         run: |
           pip install -v -e .
-          pip install -r requirements/docs.txt
-          pip install -r requirements/test.txt
+          pip install -r requirements.txt
       - name: Run tests
         run: |
-          cd tests
-          pytest
+          pytest --cov=webdavclient --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage report
+        uses: actions/[email protected]
+        with:
+          name: coverage-report
+          path: coverage.xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/[email protected]
+        with:
+          # If your repository is public, you can omit the token
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+
       - name: Build web page
         run: |
           cd docs

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonas Heinle
+
+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.

README.md

@@ -14,14 +14,21 @@
 </h1> -->
 
 <h4 align="center">Download files via webdav easily. Use it to communicate to cloud storage provider (e.g. Nextcloud, ownCloud, Magenta, Synology NAS,
-QNAPS NAS) and automate your personal storage tasks.
+QNAPS NAS) and automate your personal storage tasks.  
+
+</br>
+
+**__Other solutions (on pyPI) did not fit my needs and/or were not actively maintained__**
  <a href="https://jonasheinle.de" target="_blank"></a>.</h4>
 
 <!-- [![Linux build](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Linux.yml/badge.svg)](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Linux.yml)
 [![Windows build](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Windows.yml/badge.svg)](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Windows.yml)
-[![TopLang](https://img.shields.io/github/languages/top/Kataglyphis/GraphicsEngineVulkan)]() -->
+-->
+[![TopLang](https://img.shields.io/github/languages/top/Kataglyphis/WebDavClient)]()
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/paypalme/JonasHeinle)
 [![Twitter](https://img.shields.io/twitter/follow/Cataglyphis_?style=social)](https://twitter.com/Cataglyphis_)
+[![Codecov Coverage](https://codecov.io/gh/Kataglyphis/WebDavClient/branch/main/graph/badge.svg)](https://codecov.io/gh/Kataglyphis/WebDavClient)
+[![Test WebDavClient + Deploy web page](https://github.com/Kataglyphis/WebDavClient/actions/workflows/pages.yml/badge.svg)](https://github.com/Kataglyphis/WebDavClient/actions/workflows/pages.yml)
 
 <p align="center">
   <a href="#about-the-project">About The Project</a> •
@@ -84,38 +91,41 @@ files from your cloud. This is an easy way to do it
 
 ### Usage Example:
 
-    ```python
-    Example usage of the method:
-        from kataglyphis_webdavclient.webdavclient import WebDavClient
-        
-        hostname = "https://yourhost.de/webdav"
-        username = "Schlawiner23"
-        password = "YOUR_PERSONAL_TOKEN"
-        remote_base_path = "MyProjectFolder"
-        local_base_path = "assets"
-        webdevclient = WebDavClient(args.hostname, args.username, args.password)
-        webdevclient.download_all_files_iterative(
-            args.remote_base_path, args.local_base_path
-        )
-    ```
+```python
+Example usage of the method:
+    from kataglyphis_webdavclient.webdavclient import WebDavClient
+
+    hostname = "https://yourhost.de/webdav"
+    username = "Schlawiner23"
+    password = "YOUR_PERSONAL_TOKEN"
+    remote_base_path = "MyProjectFolder"
+    local_base_path = "assets"
+    webdevclient = WebDavClient(args.hostname, args.username, args.password)
+    webdevclient.download_all_files_iterative(
+        args.remote_base_path, args.local_base_path
+    )
+```
 
 ### Key Features
 
 <!-- ❌  -->
-<!-- |          Feature                    |   Implement Status |
+|          Feature                    |   Implement Status |
 | ------------------------------------| :----------------: |
-| Rasterizer                          |         ✔️         |
-| Raytracing                          |         ✔️         |
-| Path tracing                        |         ✔️         |
-| PBR support (UE4,disney,... etc.)   |         ✔️         |
-| .obj Model loading                  |         ✔️         |
-| Mip Mapping                         |         ✔️         | -->
+| Download all files from remote host |         ✔️         |
 
 ### Dependencies
+I use Python 3.11
+
 This enumeration also includes submodules.
 
-  * Python dependencies are listed in requirements.txt and in the 
-    requirements folder
+* Python dependencies are listed in requirements.txt and in the 
+  requirements folder
+
+```bash
+  conda create --name WebDavClient python=3.11
+  conda activate WebDavClient
+  pip install -r requirements.txt
+```
 <!-- * [Vulkan 1.3](https://www.vulkan.org/) -->
 
 ### Useful tools
@@ -135,6 +145,7 @@ This enumeration also includes submodules.
    ```
 
 ## Tests
+Run pytest in root directory :smile:
 
 <!-- ROADMAP -->
 ## Roadmap
@@ -163,7 +174,7 @@ Contributions are what make the open source community such an amazing place to b
 
 Jonas Heinle - [@Cataglyphis_](https://twitter.com/Cataglyphis_) - [email protected]
 
-Project Link: [https://github.com/Kataglyphis/...](https://github.com/Kataglyphis/...)
+Project Link: [https://github.com/Kataglyphis/WebDavClient](https://github.com/Kataglyphis/WebDavClient)
 
 
 <!-- ACKNOWLEDGEMENTS -->

docs/source/conf.py

@@ -26,18 +26,32 @@
     "myst_parser",  # adding .md files
 ]
 
+myst_enable_extensions = [
+    "dollarmath",  # Enables dollar-based math syntax
+    "amsmath",  # Supports extended LaTeX math environments
+    "colon_fence",  # Allows ::: for directives
+    "deflist",  # Enables definition lists
+]
+
 templates_path = ["_templates"]
 exclude_patterns = []
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
+html_theme = "press"
+html_theme_options = {
+    "palette": "dark",  # Set dark mode as default
+    "fixed_sidebar": True,
+}
 html_static_path = ["_static"]
 
 # Enable the processing of Markdown files
 source_suffix = {
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
+
+# Here we assume that the file is at _static/css/custom.css
+html_css_files = ["css/custom.css"]