labapi 1.0.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. labapi/__init__.py +77 -0
  2. labapi/client.py +835 -0
  3. labapi/entry/__init__.py +28 -0
  4. labapi/entry/attachment.py +191 -0
  5. labapi/entry/collection.py +209 -0
  6. labapi/entry/comment.py +15 -0
  7. labapi/entry/entries/__init__.py +22 -0
  8. labapi/entry/entries/attachment.py +148 -0
  9. labapi/entry/entries/base.py +139 -0
  10. labapi/entry/entries/text.py +69 -0
  11. labapi/entry/entries/unknown.py +41 -0
  12. labapi/entry/entries/widget.py +29 -0
  13. labapi/exceptions.py +80 -0
  14. labapi/py.typed +1 -0
  15. labapi/tree/__init__.py +21 -0
  16. labapi/tree/collection.py +163 -0
  17. labapi/tree/directory.py +57 -0
  18. labapi/tree/mixins.py +852 -0
  19. labapi/tree/notebook.py +69 -0
  20. labapi/tree/page.py +218 -0
  21. labapi/user.py +146 -0
  22. labapi/util/__init__.py +45 -0
  23. labapi/util/browser.py +125 -0
  24. labapi/util/extract.py +124 -0
  25. labapi/util/path.py +367 -0
  26. labapi/util/types.py +76 -0
  27. labapi-1.0.3.dist-info/METADATA +210 -0
  28. labapi-1.0.3.dist-info/RECORD +31 -0
  29. labapi-1.0.3.dist-info/WHEEL +5 -0
  30. labapi-1.0.3.dist-info/licenses/LICENSE +121 -0
  31. labapi-1.0.3.dist-info/top_level.txt +1 -0
labapi/__init__.py ADDED
@@ -0,0 +1,77 @@
1
+ """LabArchives API Client Library.
2
+
3
+ This package provides a Python client for interacting with the LabArchives API.
4
+ It offers an object-oriented interface to manage notebooks, folders, pages,
5
+ and various entry types, along with authentication and utility functions.
6
+
7
+ Key components include:
8
+
9
+ - :class:`~labapi.client.Client`: The main API client for connection and authentication.
10
+ - :class:`~labapi.user.User`: Represents an authenticated user session.
11
+ - :mod:`~labapi.tree`: Modules for managing the hierarchical tree structure (notebooks, directories, pages).
12
+ - :mod:`~labapi.entry`: Modules for handling different types of entries within pages.
13
+ - :mod:`~labapi.util`: General utility functions and data structures.
14
+ """
15
+
16
+ from importlib.metadata import PackageNotFoundError, version
17
+
18
+ from .client import Client
19
+ from .entry import (
20
+ Attachment,
21
+ AttachmentEntry,
22
+ Entry,
23
+ HeaderEntry,
24
+ PlainTextEntry,
25
+ TextEntry,
26
+ UnknownEntry,
27
+ WidgetEntry,
28
+ )
29
+ from .exceptions import (
30
+ ApiError,
31
+ AuthenticationError,
32
+ LabArchivesError,
33
+ NodeExistsError,
34
+ PathError,
35
+ TraversalError,
36
+ )
37
+ from .tree import (
38
+ AbstractTreeContainer,
39
+ Notebook,
40
+ NotebookDirectory,
41
+ NotebookPage,
42
+ )
43
+ from .user import User
44
+ from .util import Index, InsertBehavior, JsonData, NotebookPath
45
+
46
+ try:
47
+ __version__ = version("labapi")
48
+ except PackageNotFoundError:
49
+ __version__ = "unknown"
50
+
51
+ __all__ = [
52
+ "AbstractTreeContainer",
53
+ "ApiError",
54
+ "Attachment",
55
+ "AttachmentEntry",
56
+ "AuthenticationError",
57
+ "Client",
58
+ "Entry",
59
+ "HeaderEntry",
60
+ "Index",
61
+ "InsertBehavior",
62
+ "JsonData",
63
+ "LabArchivesError",
64
+ "NodeExistsError",
65
+ "Notebook",
66
+ "NotebookDirectory",
67
+ "NotebookPage",
68
+ "NotebookPath",
69
+ "PathError",
70
+ "PlainTextEntry",
71
+ "TextEntry",
72
+ "TraversalError",
73
+ "UnknownEntry",
74
+ "User",
75
+ "WidgetEntry",
76
+ "__version__",
77
+ ]