Skip to main content

roundup like nosylist component for the CubicWeb framework

Project description

Summary

This cube provides nosy-list “a la roundup” usable to notify users of events they subscribed to such as content modification, state change, etc.

A nosy list is an ad-hoc mailing list for entities where to which user can register, or be automatically registered on some action.

Usage

to use this cube:

  1. add to your schema:

    CWUser interested_in X
    X nosy_list CWUser

    where X are entity types considered as notification base, eg controlling who will be notified for events related to X.

  2. configure on which relation the nosy list should be propagated

    from cubes.nosylist import hooks as nosylist_hooks
    
    # relations where the "main" entity (eg holding the reference nosy list, so
    # should be in one `X` types cited above) is the subject of the relation
    nosylist_hooks.S_RELS |= set(('documented_by', 'attachment', 'screenshot'))
    
    # relations where the "main" entity (eg holding the reference nosy list, so
    # should be in one `X` types cited above) is the object of the relation
    nosylist_hooks.O_RELS |= set(('for_version', 'comments'))
  3. write hooks that add user to nosy list when desired (for instance, when a user is adding a comment to an entity, add him to the entity’s nosy list)

  4. define your notification views / hooks, which should rely on the default recipients finder mecanism to get notified users (automatic if you’re using cubicweb base classes)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cubicweb-nosylist-1.0.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

cubicweb_nosylist-1.0.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file cubicweb-nosylist-1.0.0.tar.gz.

File metadata

  • Download URL: cubicweb-nosylist-1.0.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for cubicweb-nosylist-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6407934d1e367630582016c3ff777714fe6c0664842f0bc33e5c657c2c0eaac2
MD5 4ecb26d77a0fa3c8e77e5967a81fb273
BLAKE2b-256 9d343228c922d07a0c0aec33a1eafcc6d478939e2b9cb6bc84dc035d04a251b5

See more details on using hashes here.

File details

Details for the file cubicweb_nosylist-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cubicweb_nosylist-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ede7b899ab9abb26db7c854541c8d5769fe9a6b734c261eb2f0806f4f5f4be7
MD5 52f7a7a92ef7238d5c27c8fcdd4d2998
BLAKE2b-256 4fdf295ef84e93d5d059e083d1035d76308f2415f786bb4e3abab9f28f96b533

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page