Merge branch 'main' into feature/set_labels

.github/workflows/test.yml

@@ -1,6 +1,6 @@
 name: Unit Tests
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   test:
@@ -18,10 +18,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-
     - name: Run unit tests
-      run: |
-        cd tests
-        python -m unittest test_omnivoreql.py
+      run: python -m unittest discover -s tests
       env:
         OMNIVORE_API_TOKEN: ${{ secrets.OMNIVORE_API_TOKEN }}

README.md

@@ -40,8 +40,11 @@ username = profile['me']['profile']['username']
 slug = articles['search']['edges'][0]['node']['slug']
 articles = omnivoreql_client.get_article(username, slug)
 
-labels = omnivoreql_client.get_labels()
 subscriptions = omnivoreql_client.get_subscriptions()
+
+labels = omnivoreql_client.get_labels()
+from omnivoreql import CreateLabelInput
+omnivoreql_client.create_label(CreateLabelInput("label1", "#00ff00", "This is label description"))
 ```
 
 ## Documentation

omnivoreql/__init__.py

@@ -1 +1,2 @@
 from .omnivoreql import OmnivoreQL
+from .models import CreateLabelInput

omnivoreql/models.py

@@ -1,6 +1,3 @@
-from dataclasses import dataclass
-from typing import Optional
-
 from dataclasses import dataclass, field
 from typing import Optional
 

omnivoreql/omnivoreql.py

@@ -1,10 +1,10 @@
-from gql import gql, Client
-from gql.transport.requests import RequestsHTTPTransport
 import uuid
-from models import CreateLabelInput
-from dataclasses import asdict
 import os
 from typing import List, Optional
+from gql.transport.requests import RequestsHTTPTransport
+from gql import gql, Client
+from dataclasses import asdict
+from .models import CreateLabelInput
 
 
 class OmnivoreQL:

setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup
+from setuptools import setup, find_packages
 import subprocess
 
 
@@ -37,7 +37,7 @@ def read_requirements():
     description="Omnivore API Client for Python",
     author="Shahriar Yazdipour",
     author_email="git@yazdipour.com",
-    packages=["omnivoreql"],
+    packages=find_packages(),
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     license="MIT",

tests/test_omnivoreql.py

@@ -2,14 +2,14 @@
 import unittest
 import sys
 from dotenv import load_dotenv
-
-# Add the parent directory to the path to import the OmnivoreQL module
-current_dir = os.path.dirname(os.path.abspath(__file__))
-omnivoreql_dir = os.path.join(current_dir, "..", "omnivoreql")
-sys.path.insert(0, omnivoreql_dir)
-from omnivoreql import OmnivoreQL, CreateLabelInput
-
-
+from omnivoreql.omnivoreql import OmnivoreQL
+from omnivoreql.models import CreateLabelInput
+
+"""
+Unit tests for the OmnivoreQL client.
+To run the tests, execute the following command:
+    python -m unittest discover -s tests
+"""
 class TestOmnivoreQL(unittest.TestCase):
     client = None
 
@@ -21,13 +21,13 @@ def setUpClass(cls):
         This method initializes the OmnivoreQL client with an API token.
         The 'OMNIVORE_API_TOKEN' must be specified either in a '.env' file located in
         the same directory as this script or passed directly when executing the test script.
-
         Example command to run tests with an environment variable:
             python -m unittest test_omnivoreql.py OMNIVORE_API_TOKEN='your_api_token_here'
 
         Raises:
             ValueError: If the 'OMNIVORE_API_TOKEN' is not set.
         """
+        print("\nStarting OmnivoreQL tests...\n")
         api_token = cls.getEnvVariable("OMNIVORE_API_TOKEN")
         if api_token is None:
             raise ValueError("OMNIVORE_API_TOKEN is not set")