Issue #14: add docs

HISTORY.rst

@@ -5,7 +5,7 @@ History
 2.2.2 (2023-04-14)
 ------------------
 
-* Support HEAD for ``SchoolClass``, ``User``, ``WorkGroup``, and ``Role``.
+* Support HEAD for ``SchoolClass``, ``User`` and ``WorkGroup``
 
 2.2.1 (2022-12-15)
 ------------------

docs/usage-school-class.rst

@@ -200,6 +200,18 @@ It is necessary to pass both ``name`` and ``school`` arguments to the :py:meth:`
      'url': 'https://10.200.3.70/ucsschool/kelvin/v1/classes/DEMOSCHOOL/testclass'}
 
 
+Check if school class exists
+----------------------------
+
+.. code-block:: python
+
+    from ucsschool.kelvin.client import Session, SchoolClassResource
+
+    async with Session(**credentials) as session:
+        if await SchoolClassResource(session=session).exists(name="testclass", school="DEMOSCHOOL"):
+            print("The school class exists!")
+
+
 Search school classes
 ---------------------
 

docs/usage-users.rst

@@ -178,6 +178,18 @@ Retrieve user
      'url': 'https://master.ucs.local/ucsschool/kelvin/v1/users/test1'}
 
 
+Check if user exists
+--------------------
+
+.. code-block:: python
+
+    from ucsschool.kelvin.client import Session, UserResource
+
+    async with Session(**credentials) as session:
+        if await UserResource(session=session).exists(name="test1"):
+            print("The user exists!")
+
+
 Search users
 ------------
 

docs/usage-workgroups.rst

@@ -205,6 +205,18 @@ It is necessary to pass both ``name`` and ``school`` arguments to the :py:meth:`
      'url': 'https://10.200.3.70/ucsschool/kelvin/v1/workgroups/DEMOSCHOOL/testworkgroup'}
 
 
+Check if workgroup exists
+-------------------------
+
+.. code-block:: python
+
+    from ucsschool.kelvin.client import Session, WorkGroupResource
+
+    async with Session(**credentials) as session:
+        if await WorkGroupResource(session=session).exists(school="DEMOSCHOOL", name="testworkgroup"):
+            print("The workgroup exists!")
+
+
 Search workgroups
 ---------------------