Metadata-Version: 2.4
Name: imio.fpaudit
Version: 0.1.3
Summary: This package contains fingerpointing log audit helper.
Home-page: http://pypi.python.org/pypi/imio.fpaudit
Author: IMIO
Author-email: dev@imio.be
License: GPL V2
Keywords: Python Zope Plone
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 6.0
Classifier: Framework :: Plone :: 6.1
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Dist: plone.api
Requires-Dist: setuptools
Requires-Dist: collective.fingerpointing
Requires-Dist: collective.documentgenerator
Provides-Extra: test
Requires-Dist: plone.app.testing; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

.. This README is meant for consumption by humans and PyPI. PyPI can render rst files so please do not use Sphinx features.
   If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
   This text does not appear on PyPI or github. It is a comment.

.. image:: https://github.com/imio/imio.fpaudit/actions/workflows/main.yml/badge.svg
    :target: https://github.com/imio/imio.fpaudit/actions/workflows/main.yml

.. image:: https://coveralls.io/repos/github/imio/imio.fpaudit/badge.svg?branch=main
    :target: https://coveralls.io/github/imio/imio.fpaudit?branch=main
    :alt: Coveralls

.. image:: https://codecov.io/gh/imio/imio.fpaudit/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/imio/imio.fpaudit

.. image:: https://img.shields.io/pypi/v/imio.fpaudit.svg
    :target: https://pypi.python.org/pypi/imio.fpaudit/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/status/imio.fpaudit.svg
    :target: https://pypi.python.org/pypi/imio.fpaudit
    :alt: Egg Status

.. image:: https://img.shields.io/pypi/pyversions/imio.fpaudit.svg?style=plastic   :alt: Supported - Python Versions

.. image:: https://img.shields.io/pypi/l/imio.fpaudit.svg
    :target: https://pypi.python.org/pypi/imio.fpaudit/
    :alt: License

=============
imio.fpaudit
=============

Fingerpointing log audit helper

Features
========

- logs can be defined in a plone configlet
- an helper method `utils.fplog` can be used to write to a defined log file
- a template (collective.documentgenerator) can be used to generate an ods or xls file from the logs.
  The template object must define the following context vars:

    * log_id: the id of the log to use
    * actions: a list of actions to filter on (ex: AUDIT,ERROR)
    * extras: a list of extra fields to use in the template (ex: col_a,col_b)

Translations
============

This product has been translated into

- Klingon (thanks, K'Plai)

Installation
============

Install imio.fpaudit by adding it to your buildout::

    [buildout]

    ...

    eggs =
        imio.fpaudit

It is also necessary to include some config lines in instance zope.conf or in buildout config,
where xxx is the path to the plone site::

    [instance]
    zope-conf-additional +=
       <product-config imio.fpaudit>
         plone-path xxx
       </product-config>

and then running ``bin/buildout``

Contribute
==========

- Issue Tracker: https://github.com/imio/imio.fpaudit/issues
- Source Code: https://github.com/imio/imio.fpaudit

License
=======

The project is licensed under the GPLv2.


Changelog
=========


0.1.3 (2026-03-24)
------------------

- Added Plone 6.1 version in buildout.
  [chris-adam]
- Refactored storage utility initialization without zope ready subscriber.
  [sgeulette]
- Renamed log method from utils.fplog to utils.fpalog to distinguish it from imio.helpers.security.fplog.
  [sgeulette]

0.1.2 (2025-03-12)
------------------

- Avoid test isolation problems by setting the default value of `log_entries`
  during install.
  [gbastien]

0.1.1 (2025-02-28)
------------------

- Corrected buildout
  [sgeulette]
- Pinned natsort.
  [sgeulette]
- Improved uninstall profile.
  [sgeulette]

0.1.0 (2025-02-20)
------------------

- Initial release.
  [sgeulette]


