new iteration(starting 0.0.26) (#45)

Added branch protection rules

---------

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -53,7 +53,7 @@ body:
     description: |
       Paste or describe the configuration setting, including software versions, to help diagnose the problem more quickly.
     placeholder: >
-      Example: nc_py_apy = 0.15.0, nextcloud = 28.0.4, etc.
+      Example: nc_py_api = 0.15.0, nextcloud = 28.0.4, etc.
   validations:
     required: true
 - type: markdown

.github/workflows/analysis-coverage-unrelated.yml

@@ -0,0 +1,27 @@
+name: Analysis & Coverage
+
+on:
+  pull_request:
+    paths-ignore:
+      - '.github/workflows/analysis-coverage.yml'
+      - 'nc_py_api/*.*'
+      - 'tests/**'
+      - 'setup.*'
+      - 'pyproject.toml'
+      - '.pre-commit-config.yaml'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ana_cov-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  tests-success:
+    permissions:
+      contents: none
+    runs-on: ubuntu-22.04
+    name: Tests-OK
+    steps:
+      - run: echo "No Tests required"

.github/workflows/analysis-coverage.yml

@@ -18,7 +18,13 @@ on:
       - 'setup.*'
       - 'pyproject.toml'
       - '.pre-commit-config.yaml'
-  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ana_cov-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 env:
   NEXTCLOUD_URL: "http://localhost:8080"
@@ -626,3 +632,12 @@ jobs:
           name: nc_log_sqlite_${{ matrix.nextcloud }}
           path: data/nextcloud.log
           if-no-files-found: warn
+
+  tests-success:
+    permissions:
+      contents: none
+    runs-on: ubuntu-22.04
+    needs: [tests-maria, tests-pgsql, tests-oci, tests-latest, tests-sqlite]
+    name: Tests-OK
+    steps:
+      - run: echo "Tests passed successfully"

.github/workflows/docs-check.yml

@@ -2,6 +2,9 @@ name: Docs check
 on:
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   build_docs:
     runs-on: ubuntu-latest

.github/workflows/docs.yml

@@ -3,6 +3,9 @@ on:
   push:
     branches: [ main ]
 
+permissions:
+  contents: read
+
 jobs:
   build_push_docs:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.26 - 2023-0x-xx]
+
+### Added
+
+- First Examples.
+- More documentation.
+- First `Notifications` APIs.
+
 ## [0.0.25 - 2023-07-25]
 
 ### Added

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """ Version of nc_py_api"""
 
-__version__ = "0.0.25"
+__version__ = "0.0.26-dev"

nc_py_api/files_sharing.py

@@ -96,21 +96,18 @@ def create(
         :param permissions: combination of the :py:class:`~nc_py_api.SharePermissions` object values.
         :param share_type: :py:class:`~nc_py_api.ShareType` value.
         :param share_with: the recipient of the shared object.
-        :param kwargs: *Additionally supported arguments*
+        :param kwargs: See below.
 
         Additionally supported arguments:
-            ``public`` - boolean indicating should share be available for non-registered users.
-                default = ``False``
-            ``password`` - string with password to protect share.
-                default = ``""``
-            ``send_password_by_talk`` - boolean indicating should password be automatically delivered using Talk.
-                default = ``False``
-            ``expire_date`` - py:class:`datetime` time when share should expire. `hours, minutes, seconds` are ignored.
-                default = None
-            ``note`` - string with note, if any.
-                default = ``""``
-            ``label`` - string with label, if any.
-                default = ``""``
+
+            * ``public`` - boolean indicating should share be available for non-registered users. default = ``False``
+            * ``password`` - string with password to protect share. default = ``""``
+            * ``send_password_by_talk`` - boolean indicating should password be automatically delivered using Talk.
+              default = ``False``
+            * ``expire_date`` - py:class:`~datetime` time when share should expire.
+              `hours, minutes, seconds` are ignored. default = ``None``
+            * ``note`` - string with note, if any. default = ``""``
+            * ``label`` - string with label, if any. default = ``""``
         """
 
         require_capabilities("files_sharing", self._session.capabilities)