sharepoint-v1-api 0.2.2__py3-none-any.whl

sharepoint_v1_api-0.2.2.dist-info/METADATA

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: sharepoint_v1_api
+Version: 0.2.2
+Author: Aske Bluhme Klok
+License: MIT
+Keywords: Sharepoint
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.2
+Requires-Dist: requests-ntlm>=1.3.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+
+# SharePoint API Python Client – Documentation
+
+This repository provides a lightweight Python client for interacting with SharePoint sites via SharePoint's REST API. The library handles NTLM authentication, list operations, file management, and time registration while abstracting SharePoint-specific implementation details.
+
+## Dependencies
+- Python ≥3.9
+- requests ≥2.32.2
+- requests-ntlm ≥1.3.0
+
+## Installation
+
+```bash
+pip install sharepoint-api
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/your-org/nc-devops-sharepoint-v1-api.git
+cd nc-devops-sharepoint-v1-api
+pip install -e .
+```
+
+## Authentication & Initialization
+The client uses NTLM authentication via `requests-ntlm`. Choose between two initialization methods:
+
+### Quick Initialization
+```python
+from sharepoint_api.SharePointAPI import SharePointAPI
+
+creds = {
+    "username": "your_user",
+    "password": "your_password",
+    "sharepoint_url": "https://your.sharepoint.com",
+    "proxies": {}
+}
+
+# Recommended compact initialization (bypasses normal constructor)
+sp: SharePointAPI = SharePointAPI._compact_init(creds)
+```
+
+### Full Initialization
+```python
+from requests_ntlm import HttpNtlmAuth
+from sharepoint_api.SharePointAPI import SharePointAPI
+
+sp = SharePointAPI(
+    sharepoint_url="https://your.sharepoint.com",
+    auth=HttpNtlmAuth("your_user", "your_password"),
+    proxies={}
+)
+```
+
+## Core Operations
+
+### List Operations
+```python
+from sharepoint_api.SharePointList import SharePointList
+
+# Get all lists in a site
+site = "YOUR_SITE"
+lists: list[SharePointList] = sp.get_lists(site)
+
+# Access specific list
+cases: SharePointList = sp.get_list_by_name(site, "Sager")
+print(cases.Title)
+
+# Filter items with CAML queries
+filters = ' and '.join([
+    "(TeamId == '3')",
+    "(Status == '11 - Modtaget')",
+    "((Status != '90 - Lukket') and (Status != '91 - Afvist'))"
+])
+filtered_items = sp.get_list_by_name(site, "Sager", filters).all_items
+```
+
+### File Operations
+```python
+from sharepoint_api.SharePointList import SharePointListItem
+
+# Upload file
+item: SharePointListItem = sp.upload_file(
+    site="cases",
+    folder="Documents",
+    file_name="report.pdf",
+    file_path="/local/path/report.pdf"
+)
+
+# Download file
+sp.download_file(
+    site="cases",
+    file_url=item.FileRef,
+    download_path="./downloads/report.pdf"
+)
+
+# Copy file
+copy_result = sp.copy_file(
+    site="cases",
+    source_url=item.FileRef,
+    target_folder="Archive",
+    new_name="report_2023.pdf"
+)
+
+# Delete file
+sp.delete_file(site="cases", file_url=item.FileRef)
+```
+
+### Folder Management
+```python
+# Check folder existence
+if not sp.folder_exists(site="cases", folder_path="Documents/Archived"):
+    sp.create_new_folder(site="cases", folder_path="Documents/Archived")
+```
+
+### Time Registration
+```python
+time_list = sp.get_time_registration_list_by_name(site="HR", list_name="TimeRegistrations")
+entries = time_list.get_items(select=["Title", "Hours", "Date"])
+for entry in entries:
+    print(f"{entry.Date}: {entry.Hours} hours - {entry.Title}")
+```
+
+### Version History
+```python
+item = sp.get_list_by_name(site="Legal", list_name="Contracts").get_item_by_id(42)
+versions = sp.get_item_versions(item)
+print(f"Item has {len(versions)} versions:")
+for v in versions:
+    print(f"Version {v.VersionLabel} by {v.CreatedBy}")
+```
+
+
+## 0.2.2 – 2025-11-28
+
+### Added
+
+- `SharePointList.fields` property to retrieve list field definitions
+
+## 0.2.1 – 2025‑11‑06
+
+### Added
+
+- Optional `select_fields` parameters to list retrieval methods for more efficient queries.
+- New public API methods:
+  - `SharePointAPI.get_group_users` – fetch users of a SharePoint group.
+- Improved error handling with explicit `TypeError` exceptions.
+- Detailed docstrings for core classes and methods (enhances IDE support).
+
+### Changed
+
+- HTTP header handling unified; corrected `X‑HTTP‑Method: PUT` for full updates.
+- Error handling improved: generic `sys.exit(1)` replaced with explicit `TypeError`/`ConnectionError` exceptions.
+
+### Fixed
+
+- Fixed incorrect PUT header that previously sent a MERGE header.
+- Minor docstring formatting issues.
+
+### Security
+
+- Enforced NTLM authentication across all request helpers.

sharepoint_v1_api-0.2.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+sharepoint_api/SharePointAPI.py,sha256=Jht8HHslbnCV_iXKOMjgr0KwnggweLgYtDsevFadN2Q,43437
+sharepoint_api/SharePointList.py,sha256=rkrrMBuCBiHaaL6PUtwmhjsVlOyNlC0-Fv8YmOxRypY,5947
+sharepoint_api/SharePointListItem.py,sha256=9yGuytUbW-g4nca0OeJHAKYinE_w65kE2fmxe9-Wl44,6223
+sharepoint_api/SharePointLists.py,sha256=vzX61w9rykHfj4hION3Qrff1BakR4wBb-OCOcyvDCXI,1605
+sharepoint_api/SharePointTimeRegistration.py,sha256=O5t0hyO6-HP1W7QY1LIaHKk9F45zQ5FpYB_RqHE1EPs,1564
+sharepoint_api/SharePointUser.py,sha256=w2UsEIiy-DpdJg5jEm0uVpfAjfALPsG9Uc7Wbm0_OeE,721
+sharepoint_api/SharePointUserList.py,sha256=YTBnUqoXHZSdK6Djg-xyc6TYhhGglJ4PzXFVI05wkyk,981
+sharepoint_api/__init__.py,sha256=vjtZtd4uyPWTV4ctA7H3m5x7oyWVwa39zlNDT3iR3iY,505
+sharepoint_v1_api-0.2.2.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+sharepoint_v1_api-0.2.2.dist-info/METADATA,sha256=BcV8Ent9r-hPEpBfIHmvJJ3RKGPx65CJkB2GzSAhzSk,4914
+sharepoint_v1_api-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sharepoint_v1_api-0.2.2.dist-info/top_level.txt,sha256=2aqHFFcN4A1cPWj5EeXIvIwzC9yra2lI7BS3FdQlLW4,15
+sharepoint_v1_api-0.2.2.dist-info/RECORD,,

sharepoint_v1_api-0.2.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sharepoint_v1_api-0.2.2.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

sharepoint_v1_api-0.2.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+sharepoint_api