invenio-audit-logs 1.0.0.dev0__tar.gz

invenio_audit_logs-1.0.0.dev0/.dockerignore

@@ -0,0 +1,15 @@
+.git
+*.gitignore
+
+*.mo
+*.pyc
+*.swp
+*.swo
+*.~
+
+.dockerignore
+Dockerfile
+docker-compose.yml
+docker-compose-dev.yml
+
+Procfile*

invenio_audit_logs-1.0.0.dev0/.editorconfig

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Python files
+[*.py]
+indent_size = 4
+# isort plugin configuration
+known_first_party = invenio_audit_logs
+multi_line_output = 2
+default_section = THIRDPARTY
+skip = .eggs
+
+# RST files (used by sphinx)
+[*.rst]
+indent_size = 4
+
+# CSS, HTML, JS, JSON, YML
+[*.{css,html,js,json,yml}]
+indent_size = 2
+
+# Matches the exact files either package.json or .github/workflows/*.yml
+[{package.json,.github/workflows/*.yml}]
+indent_size = 2
+
+# Dockerfile
+[Dockerfile]
+indent_size = 4

invenio_audit_logs-1.0.0.dev0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+
+name: Publish
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build-n-publish:
+    uses: inveniosoftware/workflows/.github/workflows/pypi-publish.yml@master
+    secrets: inherit
+    with:
+      babel-compile-catalog: false

invenio_audit_logs-1.0.0.dev0/.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - "feature/*"
+      - "maint-**"
+  pull_request:
+    branches:
+      - master
+      - "maint-**"
+      - "feature/**"
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron: "0 3 * * 6"
+  workflow_dispatch:
+    inputs:
+      reason:
+        description: "Reason"
+        required: false
+        default: "Manual trigger"
+
+jobs:
+  Python:
+      uses: inveniosoftware/workflows/.github/workflows/tests-python.yml@master
+      with:
+        extras: "tests"

invenio_audit_logs-1.0.0.dev0/.tx/config

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+# TODO: Transifex integration
+#
+# 1) Create message catalog:
+#    $ python setup.py extract_messages
+#    $ python setup.py init_catalog -l <lang>
+#    $ python setup.py compile_catalog
+# 2) Ensure project has been created on Transifex under the inveniosoftware
+#    organisation.
+# 3) Install the transifex-client
+#    $ pip install transifex-client
+# 4) Push source (.pot) and translations (.po) to Transifex
+#    $ tx push -s -t
+# 5) Pull translations for a single language from Transifex
+#    $ tx pull -l <lang>
+# 6) Pull translations for all languages from Transifex
+#    $ tx pull -a
+
+[main]
+host = https://www.transifex.com
+
+[invenio.invenio-audit-logs-messages]
+file_filter = invenio_audit_logs/translations/<lang>/LC_MESSAGES/messages.po
+source_file = invenio_audit_logs/translations/messages.pot
+source_lang = en
+type = PO

invenio_audit_logs-1.0.0.dev0/AUTHORS.rst

@@ -0,0 +1,13 @@
+..
+    Copyright (C) 2025 CERN.
+
+    Invenio-Audit-Logs is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+Authors
+=======
+
+Module providing audit logging features for Invenio.
+
+- CERN <info@inveniosoftware.org>

invenio_audit_logs-1.0.0.dev0/CHANGES.rst

@@ -0,0 +1,13 @@
+..
+    Copyright (C) 2025 CERN.
+
+    Invenio-Audit-Logs is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+Changes
+=======
+
+Version 1.0.0.dev0 (released 2025-04-28)
+
+- Initial dev release.

invenio_audit_logs-1.0.0.dev0/CONTRIBUTING.rst

@@ -0,0 +1,118 @@
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/inveniosoftware/invenio-audit-logs/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"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Invenio-Audit-Logs could always use more documentation, whether as part of the
+official Invenio-Audit-Logs 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/inveniosoftware/invenio-audit-logs/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 `invenio-audit-logs` for local development.
+
+1. Fork the `inveniosoftware/invenio-audit-logs` repo on GitHub.
+2. Clone your fork locally:
+
+   .. code-block:: console
+
+      $ git clone git@github.com:your_name_here/invenio-audit-logs.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:
+
+   .. code-block:: console
+
+      $ mkvirtualenv invenio-audit-logs
+      $ cd invenio-audit-logs/
+      $ pip install -e .[all]
+
+4. Create a branch for local development:
+
+   .. code-block:: console
+
+      $ 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 tests:
+
+   .. code-block:: console
+
+      $ ./run-tests.sh
+
+   The tests will provide you with test coverage and also check PEP8
+   (code style), PEP257 (documentation), flake8 as well as build the Sphinx
+   documentation and run doctests.
+
+6. Commit your changes and push your branch to GitHub:
+
+   .. code-block:: console
+
+      $ git add .
+      $ git commit -s
+          -m "component: title without verbs"
+          -m "* NEW Adds your new feature."
+          -m "* FIX Fixes an existing issue."
+          -m "* BETTER Improves and existing feature."
+          -m "* Changes something that should not be visible in release notes."
+      $ 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 and must not decrease test coverage.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring.
+3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
+   https://github.com/inveniosoftware/inveniosoftware/invenio-audit-logs/actions?query=event%3Apull_request
+   and make sure that the tests pass for all supported Python versions.

invenio_audit_logs-1.0.0.dev0/INSTALL.rst

@@ -0,0 +1,8 @@
+Installation
+============
+
+Invenio-Audit-Logs is on PyPI so all you need is:
+
+.. code-block:: console
+
+   $ pip install invenio-audit-logs

invenio_audit_logs-1.0.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Invenio digital repository framework
+
+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.

invenio_audit_logs-1.0.0.dev0/MANIFEST.in

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+# TODO: Generate this manifest file by running the following commands:
+# (please sort the lines in this file after running below commands)
+#
+#  git init
+#  git add -A
+#  pip install -e .[all]
+#  check-manifest -u
+
+include .dockerignore
+include .editorconfig
+include .tx/config
+prune docs/_build
+recursive-include .github/workflows *.yml
+recursive-include invenio_audit_logs/translations *.po *.pot *.mo
+
+# added by check-manifest
+include *.md
+include *.rst
+include *.sh
+include babel.ini
+recursive-include docs *.bat
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+recursive-include invenio_audit_logs *.json
+recursive-include invenio_audit_logs *.py
+recursive-include tests *.py

invenio_audit_logs-1.0.0.dev0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: invenio-audit-logs
+Version: 1.0.0.dev0
+Summary: Module providing audit logging features for Invenio.
+Home-page: https://github.com/inveniosoftware/invenio-audit-logs
+Author: CERN
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: invenio TODO
+Platform: any
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.8
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: invenio-base<3.0.0,>=2.0.0
+Requires-Dist: invenio-i18n<4.0.0,>=3.0.0
+Requires-Dist: invenio-indexer<4.0.0,>=3.1.0
+Requires-Dist: invenio-records-resources<8.0.0,>=7.0.0
+Requires-Dist: invenio-administration<4.0.0,>=3.1.0
+Requires-Dist: invenio-accounts<7.0.0,>=6.0.0
+Provides-Extra: tests
+Requires-Dist: pytest-black-ng>=0.4.0; extra == "tests"
+Requires-Dist: pytest-invenio<4.0.0,>=3.0.0; extra == "tests"
+Requires-Dist: invenio-db<3.0.0,>=2.0.0; extra == "tests"
+Requires-Dist: invenio-app<3.0.0,>=2.1.0; extra == "tests"
+Requires-Dist: invenio-indexer<4.0.0,>=3.1.0; extra == "tests"
+Requires-Dist: Sphinx>=4.5.0; extra == "tests"
+Provides-Extra: elasticsearch7
+Requires-Dist: invenio-search[elasticsearch7]<4.0.0,>=3.0.0; extra == "elasticsearch7"
+Provides-Extra: opensearch1
+Requires-Dist: invenio-search[opensearch1]<4.0.0,>=3.0.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "opensearch2"
+Dynamic: license-file
+
+..
+    Copyright (C) 2025 CERN.
+
+    Invenio-Audit-Logs is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+====================
+ Invenio-Audit-Logs
+====================
+
+.. image:: https://github.com/inveniosoftware/invenio-audit-logs/workflows/CI/badge.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/actions?query=workflow%3ACI
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-audit-logs.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-audit-logs.svg
+        :target: https://pypi.python.org/pypi/invenio-audit-logs
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-audit-logs.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/blob/master/LICENSE
+
+Module providing audit logging features for Invenio.
+
+TODO: Please provide feature overview of module
+
+Further documentation is available on
+https://invenio-audit-logs.readthedocs.io/
+
+..
+    Copyright (C) 2025 CERN.
+
+    Invenio-Audit-Logs is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+Changes
+=======
+
+Version 1.0.0.dev0 (released 2025-04-28)
+
+- Initial dev release.

invenio_audit_logs-1.0.0.dev0/README.md

@@ -0,0 +1 @@
+# invenio-audit-logs

invenio_audit_logs-1.0.0.dev0/README.rst

@@ -0,0 +1,29 @@
+..
+    Copyright (C) 2025 CERN.
+
+    Invenio-Audit-Logs is free software; you can redistribute it and/or
+    modify it under the terms of the MIT License; see LICENSE file for more
+    details.
+
+====================
+ Invenio-Audit-Logs
+====================
+
+.. image:: https://github.com/inveniosoftware/invenio-audit-logs/workflows/CI/badge.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/actions?query=workflow%3ACI
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-audit-logs.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-audit-logs.svg
+        :target: https://pypi.python.org/pypi/invenio-audit-logs
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-audit-logs.svg
+        :target: https://github.com/inveniosoftware/invenio-audit-logs/blob/master/LICENSE
+
+Module providing audit logging features for Invenio.
+
+TODO: Please provide feature overview of module
+
+Further documentation is available on
+https://invenio-audit-logs.readthedocs.io/

invenio_audit_logs-1.0.0.dev0/babel.ini

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Audit-Logs is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+# Extraction from Python source files
+
+[python: **.py]
+encoding = utf-8
+
+# Extraction from Jinja2 templates
+
+[jinja2: **/templates/**.html]
+encoding = utf-8
+
+# Extraction from JavaScript files
+
+[javascript: **.js]
+encoding = utf-8
+extract_messages = $._, jQuery._