Add doc strings to public API + add attempt errors + reorganize some files (#27)

Go through and add docstrings to almost the entirety of the public API,
including examples and other niceties. This should be quite helpful to
many people because VSCode renders Python docstrings when hovering over
symbols. It could also be presumably used for producing Python docs, but
I'm not going to bother with that.

Add an `AttemptError` data class that unmarshals itself from `errors` on
an insertion, although this will likely be only nominally useful since
newly inserted rows never have any errors yet.

Also, shift around some types around so they're in files named
appropriately for what they are (e.g. `insert_opts.py`) rather than
generic names (e.g. `model.py`). This also helps match the structure of
the Ruby project so that it's easier to find things.

Author: brandur

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add doc strings for most of the public API. [PR #27](https://github.com/riverqueue/riverqueue-python/pull/27).
+- Add `riverqueue.AttemptError` data class to represent errors on a job row. [PR #27](https://github.com/riverqueue/riverqueue-python/pull/27).
+
 ## [0.5.0] - 2024-07-06
 
 ### Changed

src/riverqueue/__init__.py

@@ -1,15 +1,22 @@
 # Reexport for more ergonomic use in calling code.
 from .client import (
+    MAX_ATTEMPTS_DEFAULT as MAX_ATTEMPTS_DEFAULT,
+    PRIORITY_DEFAULT as PRIORITY_DEFAULT,
+    QUEUE_DEFAULT as QUEUE_DEFAULT,
+    UNIQUE_STATES_DEFAULT as UNIQUE_STATES_DEFAULT,
     AsyncClient as AsyncClient,
     JobArgs as JobArgs,
     JobArgsWithInsertOpts as JobArgsWithInsertOpts,
     Client as Client,
     InsertManyParams as InsertManyParams,
+)
+from .client import (
     InsertOpts as InsertOpts,
+    InsertResult as InsertResult,
     UniqueOpts as UniqueOpts,
 )
-from .model import (
-    InsertResult as InsertResult,
+from .job import (
+    AttemptError as AttemptError,
     Job as Job,
     JobState as JobState,
 )