data-annalist 0.1.0__tar.gz

data-annalist-0.1.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Nic Mostert <nicolas.mostert@horizons.govt.nz>
+
+Contributors
+------------
+
+None yet. Why not be the first?

data-annalist-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. 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/nicmostert/annalist.git.
+
+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
+~~~~~~~~~~~~~~~~~~~
+
+Annalist could always use more documentation, whether as part of the
+official Annalist 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/nicmostert/annalist.git.
+
+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 `annalist` for local development.
+
+1. Fork the `annalist` repo on GitLab.
+2. Clone your fork locally::
+
+    $ git clone https://github.com/nicmostert/annalist.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 annalist
+    $ cd annalist/
+    $ python -m venv <path to venv>
+    $ source <path to venv>/bin/activate
+    $ pip install -r requirements_dev.txt
+    $ 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 annalist tests
+    $ python setup.py test or pytest
+    $ 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.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_annalist
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

data-annalist-0.1.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2023-09-13)
+------------------
+
+* First release on PyPI.

data-annalist-0.1.0/LICENSE

@@ -0,0 +1,32 @@
+GNU GENERAL PUBLIC LICENSE
+                      Version 3, 29 June 2007
+
+    Audit trail generator for data processing scripts.
+    Copyright (C) 2023  Nic Mostert
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

data-annalist-0.1.0/MANIFEST.in

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

data-annalist-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: data-annalist
+Version: 0.1.0
+Summary: Audit trail generator for data processing scripts.
+Home-page: https://github.com/nicmostert/annalist.git
+Author: Nic Mostert
+Author-email: nicolas.mostert@horizons.govt.nz
+License: GNU General Public License v3
+Keywords: annalist
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+==========
+Annalist
+==========
+
+.. image:: https://img.shields.io/pypi/v/annalist.svg
+        :target: https://pypi.python.org/pypi/annalist
+
+.. image:: https://readthedocs.org/projects/annalist/badge/?version=latest
+        :target: https://annalist.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+.. image:: https://results.pre-commit.ci/badge/github/nicmostert/annalist/main.svg
+   :target: https://results.pre-commit.ci/latest/github/nicmostert/annalist/main
+   :alt: pre-commit.ci status
+
+Audit trail generator for data processing scripts.
+
+
+* Free software: GNU General Public License v3
+* Documentation: https://annalist.readthedocs.io.
+
+
+==================
+Feature Roadmap
+==================
+
+This roadmap outlines the planned features and milestones for the development of our deterministic and reproducible process auditing system.
+
+Milestone 1: Audit Logging Framework
+-------------------------------------
+- Develop a custom audit logging framework or class.
+- Capture function names, input parameters, return values, data types, and timestamps.
+- Implement basic logging mechanisms for integration.
+
+Milestone 2: Standardized Logging Format
+-----------------------------------------
+- Define a standardized logging format for comprehensive auditing.
+- Ensure consistency and machine-readability of the logging format.
+
+Milestone 3: Serialization and Deserialization
+----------------------------------------------
+- Implement serialization and deserialization mechanisms.
+- Store and retrieve complex data structures and objects.
+- Test serialization for data integrity.
+
+Milestone 4: Versioning and Dependency Tracking
+-----------------------------------------------
+- Capture and log codebase version (Git commit hash) and dependencies.
+- Ensure accurate logging of version and dependency information.
+
+Milestone 5: Integration Testing
+--------------------------------
+- Create integration tests using the audit logging framework.
+- Log information during the execution of key processes.
+- Begin development of process recreation capability.
+
+Milestone 6: Reproduction Tool (Partial)
+----------------------------------------
+- Develop a tool or script to read and reproduce processes from the audit trail.
+- Focus on recreating the environment and loading serialized data.
+
+Milestone 7: Documentation (Partial)
+--------------------------------------
+- Create initial documentation.
+- Explain how to use the audit logging framework and the audit trail format.
+- Document basic project functionalities.
+
+Milestone 8: Error Handling
+---------------------------
+- Implement robust error handling for auditing and reproduction code.
+- Gracefully handle potential issues.
+- Provide informative and actionable error messages.
+
+Milestone 9: MVP Testing
+-------------------------
+- Conduct testing of the MVP.
+- Reproduce processes from the audit trail and verify correctness.
+- Gather feedback from initial users within the organization.
+
+Milestone 10: MVP Deployment
+------------------------------
+- Deploy the MVP within the organization.
+- Make it available to relevant team members.
+- Encourage usage and collect user feedback.
+
+Milestone 11: Feedback and Iteration
+--------------------------------------
+- Gather feedback from MVP users.
+- Identify shortcomings, usability issues, or missing features.
+- Prioritize and plan improvements based on user feedback.
+
+Milestone 12: Scaling and Extending
+------------------------------------
+- Explore scaling the solution to cover more processes.
+- Add additional features and capabilities to enhance usability.
+
+Please note that milestones may overlap, and the order can be adjusted based on project-specific needs. We aim to remain flexible and responsive to feedback during development.
+
+=======
+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
+
+
+=======
+History
+=======
+
+0.1.0 (2023-09-13)
+------------------
+
+* First release on PyPI.
+
+

data-annalist-0.1.0/README.rst

@@ -0,0 +1,106 @@
+==========
+Annalist
+==========
+
+.. image:: https://img.shields.io/pypi/v/annalist.svg
+        :target: https://pypi.python.org/pypi/annalist
+
+.. image:: https://readthedocs.org/projects/annalist/badge/?version=latest
+        :target: https://annalist.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+.. image:: https://results.pre-commit.ci/badge/github/nicmostert/annalist/main.svg
+   :target: https://results.pre-commit.ci/latest/github/nicmostert/annalist/main
+   :alt: pre-commit.ci status
+
+Audit trail generator for data processing scripts.
+
+
+* Free software: GNU General Public License v3
+* Documentation: https://annalist.readthedocs.io.
+
+
+==================
+Feature Roadmap
+==================
+
+This roadmap outlines the planned features and milestones for the development of our deterministic and reproducible process auditing system.
+
+Milestone 1: Audit Logging Framework
+-------------------------------------
+- Develop a custom audit logging framework or class.
+- Capture function names, input parameters, return values, data types, and timestamps.
+- Implement basic logging mechanisms for integration.
+
+Milestone 2: Standardized Logging Format
+-----------------------------------------
+- Define a standardized logging format for comprehensive auditing.
+- Ensure consistency and machine-readability of the logging format.
+
+Milestone 3: Serialization and Deserialization
+----------------------------------------------
+- Implement serialization and deserialization mechanisms.
+- Store and retrieve complex data structures and objects.
+- Test serialization for data integrity.
+
+Milestone 4: Versioning and Dependency Tracking
+-----------------------------------------------
+- Capture and log codebase version (Git commit hash) and dependencies.
+- Ensure accurate logging of version and dependency information.
+
+Milestone 5: Integration Testing
+--------------------------------
+- Create integration tests using the audit logging framework.
+- Log information during the execution of key processes.
+- Begin development of process recreation capability.
+
+Milestone 6: Reproduction Tool (Partial)
+----------------------------------------
+- Develop a tool or script to read and reproduce processes from the audit trail.
+- Focus on recreating the environment and loading serialized data.
+
+Milestone 7: Documentation (Partial)
+--------------------------------------
+- Create initial documentation.
+- Explain how to use the audit logging framework and the audit trail format.
+- Document basic project functionalities.
+
+Milestone 8: Error Handling
+---------------------------
+- Implement robust error handling for auditing and reproduction code.
+- Gracefully handle potential issues.
+- Provide informative and actionable error messages.
+
+Milestone 9: MVP Testing
+-------------------------
+- Conduct testing of the MVP.
+- Reproduce processes from the audit trail and verify correctness.
+- Gather feedback from initial users within the organization.
+
+Milestone 10: MVP Deployment
+------------------------------
+- Deploy the MVP within the organization.
+- Make it available to relevant team members.
+- Encourage usage and collect user feedback.
+
+Milestone 11: Feedback and Iteration
+--------------------------------------
+- Gather feedback from MVP users.
+- Identify shortcomings, usability issues, or missing features.
+- Prioritize and plan improvements based on user feedback.
+
+Milestone 12: Scaling and Extending
+------------------------------------
+- Explore scaling the solution to cover more processes.
+- Add additional features and capabilities to enhance usability.
+
+Please note that milestones may overlap, and the order can be adjusted based on project-specific needs. We aim to remain flexible and responsive to feedback during development.
+
+=======
+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

data-annalist-0.1.0/annalist/__init__.py

@@ -0,0 +1,5 @@
+"""Top-level package for Annalist."""
+
+__author__ = """Nic Mostert"""
+__email__ = "nicolas.mostert@horizons.govt.nz"
+__version__ = "0.1.0"

data-annalist-0.1.0/annalist/annalist.py

@@ -0,0 +1,39 @@
+"""Main module."""
+
+import logging
+
+GET_DATA = 25
+PROCESS = 26
+PUT_DATA = 27
+
+logging.addLevelName(GET_DATA, "GET_DATA")
+logging.addLevelName(PROCESS, "PROCESS")
+logging.addLevelName(PUT_DATA, "PUT_DATA")
+
+
+auditor = logging.getLogger("auditor")
+handler = logging.StreamHandler()
+formatter = logging.Formatter(
+    "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+)
+handler.setFormatter(formatter)
+auditor.addHandler(handler)
+auditor.setLevel(GET_DATA)
+
+
+def decorator_logger(func):
+    def wrapper(*args, **kwargs):
+        result = func(*args, **kwargs)
+        function_name = func.__name__
+        function_class = func.__class__
+        function_module = func.__module__
+        function_dir = dir(func)
+        function_doc = func.__doc__
+        auditor.log(PROCESS, function_name)
+        auditor.log(PROCESS, function_class)
+        auditor.log(PROCESS, function_module)
+        auditor.log(PROCESS, function_dir)
+        auditor.log(PROCESS, function_doc)
+        return result
+
+    return wrapper

data-annalist-0.1.0/data_annalist.egg-info/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: data-annalist
+Version: 0.1.0
+Summary: Audit trail generator for data processing scripts.
+Home-page: https://github.com/nicmostert/annalist.git
+Author: Nic Mostert
+Author-email: nicolas.mostert@horizons.govt.nz
+License: GNU General Public License v3
+Keywords: annalist
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+==========
+Annalist
+==========
+
+.. image:: https://img.shields.io/pypi/v/annalist.svg
+        :target: https://pypi.python.org/pypi/annalist
+
+.. image:: https://readthedocs.org/projects/annalist/badge/?version=latest
+        :target: https://annalist.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+.. image:: https://results.pre-commit.ci/badge/github/nicmostert/annalist/main.svg
+   :target: https://results.pre-commit.ci/latest/github/nicmostert/annalist/main
+   :alt: pre-commit.ci status
+
+Audit trail generator for data processing scripts.
+
+
+* Free software: GNU General Public License v3
+* Documentation: https://annalist.readthedocs.io.
+
+
+==================
+Feature Roadmap
+==================
+
+This roadmap outlines the planned features and milestones for the development of our deterministic and reproducible process auditing system.
+
+Milestone 1: Audit Logging Framework
+-------------------------------------
+- Develop a custom audit logging framework or class.
+- Capture function names, input parameters, return values, data types, and timestamps.
+- Implement basic logging mechanisms for integration.
+
+Milestone 2: Standardized Logging Format
+-----------------------------------------
+- Define a standardized logging format for comprehensive auditing.
+- Ensure consistency and machine-readability of the logging format.
+
+Milestone 3: Serialization and Deserialization
+----------------------------------------------
+- Implement serialization and deserialization mechanisms.
+- Store and retrieve complex data structures and objects.
+- Test serialization for data integrity.
+
+Milestone 4: Versioning and Dependency Tracking
+-----------------------------------------------
+- Capture and log codebase version (Git commit hash) and dependencies.
+- Ensure accurate logging of version and dependency information.
+
+Milestone 5: Integration Testing
+--------------------------------
+- Create integration tests using the audit logging framework.
+- Log information during the execution of key processes.
+- Begin development of process recreation capability.
+
+Milestone 6: Reproduction Tool (Partial)
+----------------------------------------
+- Develop a tool or script to read and reproduce processes from the audit trail.
+- Focus on recreating the environment and loading serialized data.
+
+Milestone 7: Documentation (Partial)
+--------------------------------------
+- Create initial documentation.
+- Explain how to use the audit logging framework and the audit trail format.
+- Document basic project functionalities.
+
+Milestone 8: Error Handling
+---------------------------
+- Implement robust error handling for auditing and reproduction code.
+- Gracefully handle potential issues.
+- Provide informative and actionable error messages.
+
+Milestone 9: MVP Testing
+-------------------------
+- Conduct testing of the MVP.
+- Reproduce processes from the audit trail and verify correctness.
+- Gather feedback from initial users within the organization.
+
+Milestone 10: MVP Deployment
+------------------------------
+- Deploy the MVP within the organization.
+- Make it available to relevant team members.
+- Encourage usage and collect user feedback.
+
+Milestone 11: Feedback and Iteration
+--------------------------------------
+- Gather feedback from MVP users.
+- Identify shortcomings, usability issues, or missing features.
+- Prioritize and plan improvements based on user feedback.
+
+Milestone 12: Scaling and Extending
+------------------------------------
+- Explore scaling the solution to cover more processes.
+- Add additional features and capabilities to enhance usability.
+
+Please note that milestones may overlap, and the order can be adjusted based on project-specific needs. We aim to remain flexible and responsive to feedback during development.
+
+=======
+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
+
+
+=======
+History
+=======
+
+0.1.0 (2023-09-13)
+------------------
+
+* First release on PyPI.
+
+

data-annalist-0.1.0/data_annalist.egg-info/SOURCES.txt

@@ -0,0 +1,32 @@
+AUTHORS.rst
+CONTRIBUTING.rst
+HISTORY.rst
+LICENSE
+MANIFEST.in
+README.rst
+setup.cfg
+setup.py
+annalist/__init__.py
+annalist/annalist.py
+data_annalist.egg-info/PKG-INFO
+data_annalist.egg-info/SOURCES.txt
+data_annalist.egg-info/dependency_links.txt
+data_annalist.egg-info/not-zip-safe
+data_annalist.egg-info/top_level.txt
+docs/Makefile
+docs/annalist.rst
+docs/authors.rst
+docs/conf.py
+docs/contributing.rst
+docs/history.rst
+docs/index.rst
+docs/installation.rst
+docs/make.bat
+docs/modules.rst
+docs/readme.rst
+docs/usage.rst
+docs/_build/html/_static/file.png
+docs/_build/html/_static/minus.png
+docs/_build/html/_static/plus.png
+tests/__init__.py
+tests/test_annalist.py

data-annalist-0.1.0/data_annalist.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

data-annalist-0.1.0/data_annalist.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

data-annalist-0.1.0/data_annalist.egg-info/top_level.txt

@@ -0,0 +1 @@
+annalist

data-annalist-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = chronicler
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

data-annalist-0.1.0/docs/annalist.rst

@@ -0,0 +1,21 @@
+annalist package
+================
+
+Submodules
+----------
+
+annalist.annalist module
+------------------------
+
+.. automodule:: annalist.annalist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: annalist
+   :members:
+   :undoc-members:
+   :show-inheritance:

data-annalist-0.1.0/docs/authors.rst

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

data-annalist-0.1.0/docs/conf.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python
+#
+# annalist documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun  9 13:47:02 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import sys
+
+# If extensions (or modules to document with autodoc) are in another
+# directory, add these directories to sys.path here. If the directory is
+# relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#
+sys.path.insert(0, os.path.abspath(".."))
+import annalist
+
+# -- General configuration ---------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "Annalist"
+copyright = "2023, Nic Mostert"
+author = "Nic Mostert"
+
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = annalist.__version__
+# The full version, including alpha/beta/rc tags.
+release = annalist.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "python"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "annalistdoc"
+
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        "annalist.tex",
+        "Annalist Documentation",
+        "Nic Mostert",
+        "manual",
+    ),
+]
+
+
+# -- Options for manual page output ------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "annalist", "Annalist Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "annalist",
+        "Annalist Documentation",
+        author,
+        "annalist",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]

data-annalist-0.1.0/docs/contributing.rst

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

data-annalist-0.1.0/docs/history.rst

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

data-annalist-0.1.0/docs/index.rst

@@ -0,0 +1,20 @@
+Welcome to Annalist's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   installation
+   usage
+   modules
+   contributing
+   authors
+   history
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

data-annalist-0.1.0/docs/installation.rst

@@ -0,0 +1,51 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install Annalist, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install annalist
+
+This is the preferred method to install Annalist, as it will always install the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for Annalist can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/nicmostert/annalist
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl -OJL https://github.com/nicmostert/annalist/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/nicmostert/annalist
+.. _tarball: https://github.com/nicmostert/annalist/tarball/master

data-annalist-0.1.0/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=annalist
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

data-annalist-0.1.0/docs/modules.rst

@@ -0,0 +1,7 @@
+annalist
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   annalist

data-annalist-0.1.0/docs/readme.rst

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

data-annalist-0.1.0/docs/usage.rst

@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+To use Annalist in a project::
+
+    import annalist

data-annalist-0.1.0/setup.cfg

@@ -0,0 +1,26 @@
+[bumpversion]
+current_version = 0.1.0
+commit = True
+tag = True
+
+[bumpversion:file:setup.py]
+search = version='{current_version}'
+replace = version='{new_version}'
+
+[bumpversion:file:annalist/__init__.py]
+search = __version__ = '{current_version}'
+replace = __version__ = '{new_version}'
+
+[bdist_wheel]
+universal = 1
+
+[flake8]
+exclude = docs
+
+[tool:pytest]
+addopts = --ignore=setup.py
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

data-annalist-0.1.0/setup.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+"""The setup script."""
+
+from setuptools import find_packages, setup
+
+with open("README.rst") as readme_file:
+    readme = readme_file.read()
+
+with open("HISTORY.rst") as history_file:
+    history = history_file.read()
+
+requirements: list[str] = []
+
+test_requirements = [
+    "pytest>=3",
+]
+
+setup(
+    author="Nic Mostert",
+    author_email="nicolas.mostert@horizons.govt.nz",
+    python_requires=">=3.6",
+    classifiers=[
+        "Development Status :: 2 - Pre-Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Natural Language :: English",
+        "Programming Language :: Python :: 3.10",
+    ],
+    description="Audit trail generator for data processing scripts.",
+    install_requires=requirements,
+    license="GNU General Public License v3",
+    long_description=readme + "\n\n" + history,
+    include_package_data=True,
+    keywords="annalist",
+    name="data-annalist",
+    packages=find_packages(include=["annalist", "annalist.*"]),
+    test_suite="tests",
+    tests_require=test_requirements,
+    url="https://github.com/nicmostert/annalist.git",
+    version="0.1.0",
+    zip_safe=False,
+)

data-annalist-0.1.0/tests/__init__.py

@@ -0,0 +1 @@
+"""Unit test package for annalist."""

data-annalist-0.1.0/tests/test_annalist.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+"""Tests for `annalist` package."""
+
+from annalist.annalist import decorator_logger
+
+
+@decorator_logger
+def len_of_string_example(str_arg):
+    return len(str_arg)
+
+
+def test_decorator_logger_functionality(caplog):
+    """Test logger behaviour"""
+    str_example = "This is a string"
+    result = len_of_string_example(str_example)
+    print([dir(rec) for rec in caplog.records])
+    log_messages = [rec.message for rec in caplog.records]
+    assert log_messages == "whatsit"
+    assert result == len(str_example)
+
+
+def test_decorator_logger_wrapper():
+    """Test decorator function directly"""
+
+    def mock_func():
+        print("Console Output to Intercept?")
+        return "Mock function called."
+
+    decorated_mock_func = decorator_logger(mock_func)
+
+    result = decorated_mock_func()
+    assert result == "Mock function called."