pyams-zfiles

==================== PyAMS ZFiles package

.. contents::

What is PyAMS?

PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications and content management with the Pyramid framework.

PyAMS is actually mainly used to manage web sites through content management applications (CMS, see PyAMS_content package), but many features are generic and can be used inside any kind of web application.

All PyAMS documentation is available on ReadTheDocs <https://pyams.readthedocs.io>; source code is available on Gitlab <https://gitlab.com/pyams> and pushed to Github <https://github.com/py-ams>_. Doctests are available in the doctests source folder.

What is ZFiles?

ZFiles is an extension package for PyAMS which allows to define a "files storage" environment.

This environment is very simple, and provides several APIs (for REST/JSON, XML-RPC or JSON-RPC protocols) which allows applications to store and retrieve external files of any type (maybe images, videos, PDF files...). Applications which are using the service just get a unique ID (called OID) when they upload a new document, which can be stored by the applications and used to retrieve them afterwards when needed.

ZFiles is just a storage manager for these documents; the lifecycle management is delegated to the applications which use it as storage backend.

Changelog

2.3.1

• update RPC API permissions checker methods to return a boolean value instead of an ACL
• added support for Python 3.12

2.3.0

• added document properties extractors, which can be used to extract some of a document properties from it's associated file content

2.2.1

• updated doctests

2.2.0

• added support for custom catalog indexes for selected documents properties

2.1.0

• added optional "created_time" argument to document creation API

2.0.7

• switched default timezone to UTC

2.0.6

• added missing documents container label provider

2.0.5

• corrected faulty import

2.0.4

• updated REST API route name and configuration setting name
• moved objects finder helper to new module
• updated doctests

2.0.3

• updated properties index values getter to correctly split values

2.0.2

• version mismatch

2.0.1

• updated modal forms title
• small updates in documents workflow

2.0.0

• upgraded to Pyramid 2.0
• updated tests for unauthenticated requests

1.4.6

• updated REST document search API schema

1.4.5

• updated access and update modes management

1.4.4

• updated Colander API schemas for better OpenAPI specifications
• added enums for workflow states

1.4.3

• updated translations

1.4.2

• updated workflow delete view

1.4.1

• updated generation evolve

1.4.0

• added multiple synchronizer configurations
• added synchronizer access to REST API

1.3.4

• updated synchronizer call result to return enums values instead of enums, which can't be converted to JSON

1.3.3

• removed permission check for CORS OPTIONS request on document data

1.3.2

• added new PyAMS_security CORS validators to REST services

1.3.1

• updated CORS support in REST API
• added support for Python 3.10

1.3.0

• added support for CORS preflight OPTIONS verb used by REST services
• updated support for search params in URL
• updated Gitlab-CI configuration
• small ZMI updates

1.2.1

• added enumeration to handle synchronizer status
• PyAMS_security interfaces refactoring

1.2.0

• added workflow label
• added "NOT_FOUND" status to documents synchronizer if given OID doesn't match an existing document
• added "NO_DATA" status to documents synchronizer if a POSError occurs when reading document data

1.1.0

• add index on properties to make them searchable

1.0.6

• updated document properties widget template

1.0.5

• added option to display menu to access documents container from ZMI home page

1.0.4

• added missing "context" argument to permission check

1.0.3

• added title to applications vocabulary terms

1.0.2

• updated application manager permissions

1.0.1

• updated context of permissions checks in REST and GraphQL APIs

1.0.0

• initial release