Skip to content

Commit 34cfd4c

Browse files
bigcat88bigcat88
authored
global refactor (#71)
Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
1 parent 9b43353 commit 34cfd4c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+874
-776
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ repos:
1919
(?x)^(
2020
nc_py_api/|
2121
benchmarks/|
22+
examples/|
2223
tests/
2324
)
2425
@@ -30,6 +31,7 @@ repos:
3031
(?x)^(
3132
nc_py_api/|
3233
benchmarks/|
34+
examples/|
3335
tests/
3436
)
3537

‎CHANGELOG.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ All notable changes to this project will be documented in this file.
44

55
## [0.0.28 - 2023-08-11]
66

7+
### Added
8+
9+
- APIs for enabling\disabling External Applications.
10+
711
### Changed
812

9-
- Finished documentation.
10-
- Different small adjustments to API, to be it more consistent.
13+
- Much more documentation.
14+
- Regroup APIs, hopes for the last time.
1115

1216
### Fixed
1317

‎docs/reference/Apps.rst‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
1-
.. py:currentmodule:: nc_py_api.apps
2-
31
Applications Management
42
-----------------------
53

6-
.. autoclass:: AppAPI
4+
.. autoclass:: nc_py_api.apps.apps.AppsAPI
75
:members:
86

9-
.. autoclass:: ExAppInfo
7+
.. autoclass:: nc_py_api.apps.apps.ExAppInfo
108
:members:
119

1210
Preferences
1311
^^^^^^^^^^^
1412

15-
.. autoclass:: nc_py_api.appcfg_prefs_ex.CfgRecord
13+
.. autoclass:: nc_py_api.apps.preferences_ex.CfgRecord
1614
:members:
1715
:undoc-members:
1816

1917
User specific
2018
"""""""""""""
2119

22-
.. autoclass:: nc_py_api.preferences.PreferencesAPI
20+
.. autoclass:: nc_py_api.apps.preferences.PreferencesAPI
2321
:members:
2422

25-
.. autoclass:: nc_py_api.appcfg_prefs_ex.PreferencesExAPI
23+
.. autoclass:: nc_py_api.apps.preferences_ex.PreferencesExAPI
2624
:members:
2725
:inherited-members:
2826

2927
Non-user specific
3028
"""""""""""""""""
3129

32-
.. autoclass:: nc_py_api.appcfg_prefs_ex.AppConfigExAPI
30+
.. autoclass:: nc_py_api.apps.preferences_ex.AppConfigExAPI
3331
:members:
3432
:inherited-members:

‎docs/reference/Constants.rst‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎docs/reference/ExApp.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. py:currentmodule:: nc_py_api.ex_app
2+
3+
External Application
4+
====================
5+
6+
Constants
7+
---------
8+
9+
.. autoclass:: ApiScope
10+
:members:
11+
12+
.. autoclass:: LogLvl
13+
:members:

‎docs/reference/Exceptions.rst‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
.. py:currentmodule:: nc_py_api.exceptions
1+
.. py:currentmodule:: nc_py_api._exceptions
22
33
Exceptions
44
==========
55

6+
Avalaible as `nc_py_api.{exception_name}`
7+
68
.. autoclass:: NextcloudException
79
:members:
810

911
.. autoclass:: NextcloudExceptionNotFound
1012
:members:
11-
12-
13-
Functions
14-
---------
15-
16-
.. autofunction:: check_error

‎docs/reference/Files/Files.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Refer to the **fs examples** to see how to use them nicely.
66

77
All File APIs are designed to work relative to the current user.
88

9-
.. autoclass:: nc_py_api.files_defs.FsNodeInfo
9+
.. autoclass:: nc_py_api.files.files.FilesAPI
1010
:members:
1111

12-
.. autoclass:: nc_py_api.files_defs.FsNode
12+
.. autoclass:: nc_py_api.files.FsNodeInfo
1313
:members:
1414

15-
.. autoclass:: nc_py_api.files.FilesAPI
15+
.. autoclass:: nc_py_api.files.FsNode
1616
:members:

‎docs/reference/Files/Shares.rst‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,17 @@ File Sharing
44
The Shares API is universal for both modes and provides all the necessary methods for working with the Nextcloud Shares system.
55
Refer to the **share examples** to see how to use them nicely.
66

7-
.. autoclass:: nc_py_api.files_defs.Share
7+
.. autoclass:: nc_py_api.files.sharing._FilesSharingAPI
88
:members:
99

10-
.. autoclass:: nc_py_api.files_sharing.FilesSharingAPI
10+
.. autoclass:: nc_py_api.files.sharing.Share
11+
:members:
12+
13+
.. autoclass:: nc_py_api.files.sharing.SharePermissions
14+
:members:
15+
16+
.. autoclass:: nc_py_api.files.sharing.ShareType
17+
:members:
18+
19+
.. autoclass:: nc_py_api.files.sharing.ShareStatus
1120
:members:

‎docs/reference/Session.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Session Structures
66
.. autoclass:: ServerVersion
77
:members:
88

9-
.. autoclass:: nc_py_api.theming.ThemingInfo
9+
.. autoclass:: nc_py_api._theming.ThemingInfo
1010
:members:
1111

1212
.. autoclass:: AppConfig
1313
:members:
1414

15-
Sessions Internal
16-
=================
15+
Internal
16+
^^^^^^^^
1717

1818
Currently Session API is private, and not exposed.
1919

‎docs/reference/Users/Notifications.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Notifications
2+
-------------
3+
4+
.. autoclass:: nc_py_api.users.notifications._NotificationsAPI
5+
:members:
6+
7+
.. autoclass:: nc_py_api.users.notifications.Notification
8+
:members:
9+
10+
.. autoclass:: nc_py_api.users.notifications.NotificationInfo
11+
:members:

0 commit comments

Comments
 (0)