Overhaul pubsub module and update docs (#15)

.pre-commit-config.yaml

@@ -28,3 +28,13 @@ repos:
     - mdformat-gfm
     - mdformat-toc
     - mdformat-web
+- repo: https://github.com/pycqa/isort
+  rev: 5.6.4
+  hooks:
+    - id: isort
+      args: ["--profile", "black", "--filter-files", "--force-sort-within-sections"]
+# - repo: https://github.com/pycqa/flake8
+#   rev: 4.0.1
+#   hooks:
+#     - id: flake8
+#       additional_dependencies: [flake8-docstrings]

CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+<!-- uncomment the following when we're out of alpha and actually following it -->
+
+<!-- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -->
+
+## \[Unreleased\]
+
+## \[0.2.0\] - 2023-06-26
+
+### Added
+
+-   `auth` module supporting authentication via a service account or oauth2
+-   `exceptions` module with class `OpenAlertError`
+-   "Overview" section in docs
+-   classes in `utils` module: `ProjectIds`, `Cast`
+-   files: `CHANGELOG.md`, `pittgoogle_env.yml`
+
+### Changed
+
+-   Overhaul the `pubsub` module. Add classes `Topic`, `Subscription`, `Consumer`, `Alert`,
+  `Response`.
+
+### Fixed
+
+-   cleanup some issues flagged by Codacy
+

README.md

@@ -1,9 +1,14 @@
+.. image:: https://readthedocs.org/projects/pitt-broker/badge/?version=latest
+:target: https://pitt-broker.readthedocs.io/en/latest/?badge=latest
+:alt: Documentation Status
+:style: flat-square
+
 # pittgoogle-client
 
 [![](https://app.codacy.com/project/badge/Grade/ec909deaf09840f3b3f645f045dea468)](https://app.codacy.com/gh/mwvgroup/pittgoogle-client/dashboard)
 [![](https://app.codacy.com/project/badge/Coverage/ec909deaf09840f3b3f645f045dea468)](https://app.codacy.com/gh/mwvgroup/pittgoogle-client/dashboard)
 
+Read the docs: [http://pittgoogle-client.rtfd.io/](http://pittgoogle-client.rtfd.io/).
+
 This is the client package for the
-[Pitt-Google astronomical alert broker](https://pitt-broker.readthedocs.io/en/latest/index.html).
-It contains tools for interacting with Pitt-Google Broker data resources.
-Read the docs at [http://pittgoogle-client.rtfd.io/](http://pittgoogle-client.rtfd.io/).
+[Pitt-Google astronomical alert broker](https://pitt-broker.rtfd.io/).

docs/requirements.txt

@@ -0,0 +1,8 @@
+# packages to support building docs
+docutils<0.17  # render lists properly
+myst-parser
+numpydoc
+sphinx
+sphinx-copybutton
+sphinx_autodoc_typehints
+sphinx_rtd_theme