Merge pull request #55 from vicampuzano/Metadata-for-periodic-notes

Adding a parameter to optionally retrieve metadata for periodic notes, in addition to just the content.
This commit is contained in:
Markus Pfundstein
2025-06-19 11:36:35 +02:00
committed by GitHub
2 changed files with 20 additions and 3 deletions

View File

@@ -173,11 +173,14 @@ class Obsidian():
return self._safe_call(call_fn)
def get_periodic_note(self, period: str) -> Any:
def get_periodic_note(self, period: str, type: str = "content") -> Any:
"""Get current periodic note for the specified period.
Args:
period: The period type (daily, weekly, monthly, quarterly, yearly)
type: Type of the data to get ('content' or 'metadata').
'content' returns just the content in Markdown format.
'metadata' includes note metadata (including paths, tags, etc.) and the content..
Returns:
Content of the periodic note
@@ -185,7 +188,10 @@ class Obsidian():
url = f"{self.get_base_url()}/periodic/{period}/"
def call_fn():
response = requests.get(url, headers=self._get_headers(), verify=self.verify_ssl, timeout=self.timeout)
headers = self._get_headers()
if type == "metadata":
headers['Accept'] = 'application/vnd.olrapi.note+json'
response = requests.get(url, headers=headers, verify=self.verify_ssl, timeout=self.timeout)
response.raise_for_status()
return response.text