healthy-api 0.10.0__tar.gz

healthy_api-0.10.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Herman Singh <kartstig@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

healthy_api-0.10.0/CONTRIBUTING.rst

@@ -0,0 +1,114 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/KartStig/healthy_api/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Healthy-API could always use more documentation, whether as part of the
+official Healthy-API docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/KartStig/healthy_api/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `healthy_api` for local development.
+
+1. Fork the `healthy_api` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/healthy_api.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv healthy_api
+    $ cd healthy_api/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 healthy_api tests
+    $ python setup.py test or py.test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
+   https://travis-ci.org/KartStig/healthy_api/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ py.test tests.test_healthy_api
+

healthy_api-0.10.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.9.0 (2023-10-01)
+------------------
+
+* First release on PyPI.

healthy_api-0.10.0/LICENSE

@@ -0,0 +1,11 @@
+
+MIT License
+
+Copyright (c) 2017, Herman Paul Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

healthy_api-0.10.0/MANIFEST.in

@@ -0,0 +1,13 @@
+
+include AUTHORS.rst
+
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

healthy_api-0.10.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.1
+Name: healthy_api
+Version: 0.10.0
+Summary: Healthy-API adds a healthcheck endpoint for all web frameworks.
+Author-email: Herman Singh <kartstig@gmail.com>
+Maintainer-email: Herman Singh <kartstig@gmail.com>
+License: MIT License
+Project-URL: Donate, https://github.com/sponsors/Kartstig/dashboard
+Project-URL: Documentation, https://readthedocs.org/projects/healthy_api
+Project-URL: Source Code, https://github.com/Kartstig/healthy_api
+Project-URL: Issue Tracker, https://github.com/Kartstig/healthy_api/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Provides-Extra: flask
+Requires-Dist: Flask>=0.12; extra == "flask"
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == "fastapi"
+Provides-Extra: all
+Requires-Dist: Flask>=0.12; extra == "all"
+Requires-Dist: fastapi; extra == "all"
+
+===============================
+Healthy-API
+===============================
+
+        Healthchecks for Any Framework (FastAPI/Flask)
+
+.. _FastAPI: https://github.com/tiangolo/fastapi/
+
+.. _Flask: https://github.com/pallets/flask/
+
+.. image:: https://img.shields.io/pypi/v/Healthy-API.svg
+        :target: https://pypi.python.org/pypi/Healthy-API
+        :alt: PyPI
+
+.. image:: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml/badge.svg?branch=master
+        :target: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml
+        :alt: GitHub Actions
+
+.. image:: https://readthedocs.org/projects/healthy-api/badge/?version=latest
+    :target: https://healthy-api.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://codecov.io/gh/Kartstig/healthy_api/graph/badge.svg?token=mTG6WudJwK
+        :target: https://codecov.io/gh/Kartstig/healthy_api
+        :alt: Codecov
+
+.. image:: https://img.shields.io/pypi/dm/Healthy-API
+        :alt: PyPI - Downloads
+
+Healthy-API is designed to work with both Flask and FastAPI. Healthy-API is really simple
+to set up. Healthy-API will provide an enpoint at `/_health` where you will get a JSON response
+of the system's uptime, current git revision, version, and function you want.
+
+You can also add in extra checks by passing in a list of checks to the
+constructor.
+
+Installing
+----------
+
+Install and update using `pip`\:
+
+.. code-block:: text
+
+        pip install -U "healthy-api[flask]"
+
+or
+
+.. code-block:: text
+
+        pip install -U "healthy-api[fastapi]"
+
+FastAPI Configuration
+---------------------
+
+.. code-block:: python
+
+  from fastapi import FastAPI
+  from healthy_api.adapters.fastapi import FlaskAdapter as HealthyApi
+
+  app = FastAPI(__name__)
+
+  def db_check():
+    """Database"""
+    try:
+        with get_session_ctx() as session:
+            (res,) = session.execute(text("SELECT 1")).fetchone()
+            return bool(res == 1)
+    except Exception as e:
+        logger.error(f"Unable to connect to database: {e}")
+        return False
+
+  HealthyApi(app, extra_checks=[db_check])
+
+
+Flask Configuration
+-------------------
+
+.. code-block:: python
+
+  from Flask import Flask
+  from healthy_api.adapters.flask import Flask as HealthyApi
+
+  app = Flask(__name__)
+
+  HealthyApi(app)
+
+Or if you can use the `init_app` function:
+
+.. code-block:: python
+
+    from Flask import Flask
+    from healthy_api.adapters.flask import Flask as HealthyApi
+
+    app = Flask(__name__)
+
+    healthy_api = HealthyApi()
+    healthy_api.init_app(app)
+
+* Free software: MIT license
+* Documentation: https://healthy_api.readthedocs.io.
+
+
+Features
+--------
+
+* Current Git Commit
+* Current Version
+* Accepts custom functions
+
+
+Configuration
+-------------
+
++---------------------+---------------------------------+------+------------+
+| Config Key          | Description                     | Type | Default    |
++=====================+=================================+======+============+
+| HAPI_ENABLE         | Enable/Disable Healthy-API      | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_GIT     | Enable/Disable Git Stats        | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_VERSION | Enable/Disable Version Stats    | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENDPOINT       | Custom Route                    | str  | /_health   |
++---------------------+---------------------------------+------+------------+
+
+
+Sponsorship
+-----------
+
+Put your logo here! `Become a sponsor`_ and support this project!
+
+.. _Become a sponsor: https://github.com/sponsors/Kartstig
+
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+

healthy_api-0.10.0/README.rst

@@ -0,0 +1,143 @@
+===============================
+Healthy-API
+===============================
+
+        Healthchecks for Any Framework (FastAPI/Flask)
+
+.. _FastAPI: https://github.com/tiangolo/fastapi/
+
+.. _Flask: https://github.com/pallets/flask/
+
+.. image:: https://img.shields.io/pypi/v/Healthy-API.svg
+        :target: https://pypi.python.org/pypi/Healthy-API
+        :alt: PyPI
+
+.. image:: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml/badge.svg?branch=master
+        :target: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml
+        :alt: GitHub Actions
+
+.. image:: https://readthedocs.org/projects/healthy-api/badge/?version=latest
+    :target: https://healthy-api.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://codecov.io/gh/Kartstig/healthy_api/graph/badge.svg?token=mTG6WudJwK
+        :target: https://codecov.io/gh/Kartstig/healthy_api
+        :alt: Codecov
+
+.. image:: https://img.shields.io/pypi/dm/Healthy-API
+        :alt: PyPI - Downloads
+
+Healthy-API is designed to work with both Flask and FastAPI. Healthy-API is really simple
+to set up. Healthy-API will provide an enpoint at `/_health` where you will get a JSON response
+of the system's uptime, current git revision, version, and function you want.
+
+You can also add in extra checks by passing in a list of checks to the
+constructor.
+
+Installing
+----------
+
+Install and update using `pip`\:
+
+.. code-block:: text
+
+        pip install -U "healthy-api[flask]"
+
+or
+
+.. code-block:: text
+
+        pip install -U "healthy-api[fastapi]"
+
+FastAPI Configuration
+---------------------
+
+.. code-block:: python
+
+  from fastapi import FastAPI
+  from healthy_api.adapters.fastapi import FlaskAdapter as HealthyApi
+
+  app = FastAPI(__name__)
+
+  def db_check():
+    """Database"""
+    try:
+        with get_session_ctx() as session:
+            (res,) = session.execute(text("SELECT 1")).fetchone()
+            return bool(res == 1)
+    except Exception as e:
+        logger.error(f"Unable to connect to database: {e}")
+        return False
+
+  HealthyApi(app, extra_checks=[db_check])
+
+
+Flask Configuration
+-------------------
+
+.. code-block:: python
+
+  from Flask import Flask
+  from healthy_api.adapters.flask import Flask as HealthyApi
+
+  app = Flask(__name__)
+
+  HealthyApi(app)
+
+Or if you can use the `init_app` function:
+
+.. code-block:: python
+
+    from Flask import Flask
+    from healthy_api.adapters.flask import Flask as HealthyApi
+
+    app = Flask(__name__)
+
+    healthy_api = HealthyApi()
+    healthy_api.init_app(app)
+
+* Free software: MIT license
+* Documentation: https://healthy_api.readthedocs.io.
+
+
+Features
+--------
+
+* Current Git Commit
+* Current Version
+* Accepts custom functions
+
+
+Configuration
+-------------
+
++---------------------+---------------------------------+------+------------+
+| Config Key          | Description                     | Type | Default    |
++=====================+=================================+======+============+
+| HAPI_ENABLE         | Enable/Disable Healthy-API      | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_GIT     | Enable/Disable Git Stats        | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_VERSION | Enable/Disable Version Stats    | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENDPOINT       | Custom Route                    | str  | /_health   |
++---------------------+---------------------------------+------+------------+
+
+
+Sponsorship
+-----------
+
+Put your logo here! `Become a sponsor`_ and support this project!
+
+.. _Become a sponsor: https://github.com/sponsors/Kartstig
+
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+

healthy_api-0.10.0/docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/healthy_api.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/healthy_api.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/healthy_api"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/healthy_api"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

healthy_api-0.10.0/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst