Pub/Sub client

.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]

README.md

@@ -1,6 +1,11 @@
+.. 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
 
+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

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