Skip to main content

pennyblack

Penyblack is a newsletter module based on the feincms.org CMS building toolkit. E-mails can either be sent as mass mails (e.g. monthly newsletter) or as part of a customised workflow (e.g. user clicks on a link and in response to that your application sends out an e-mail). Conditional data and variables can be filled in to a newsletter using the django template language. SPF (sender validation) and bounce management can be activated if desired. Key data like bounce rate, opening rate and link clicks is tracked and presented in the admin menu. Sending bulk e-mails is easy on memory. 20’000 and more addresses wont crash your server. From the outset we developed Pennyblack to easily integrate into existing web projects.

Installation

Notice: This is a first draft of an installation guide. It’s not finished and complete.

  1. Make sure you have a working django project setup.

  2. Install Pennyblack over pip:

    pip install pennyblack
  3. Make sure that the FeinCMS and Pennyblack Apps are added to your installed apps in your settings.py:

    'feincms',
    'feincms.module.medialibrary',
    'pennyblack',
    'pennyblack.module.subscriber',
  4. Add a newsletter url to your urls.py:

    url(r'^newsletter/', include('pennyblack.urls'), name = 'pennyblack'),
  5. Install dependencies (over pip):

    • pydns==2.3.4

    • pyspf==2.0.5

  6. Import Pennyblack and add a newsletter template to your models.py:

    from pennyblack.models.newsletter import Newsletter
    from pennyblack.content.richtext import TextOnlyNewsletterContent, \
       TextWithImageNewsletterContent
    
    Newsletter.register_templates({
      'key': 'example',
      'title': 'Example Newsletter',
      'path': 'example_newsletter.html',
      'regions': (
          ('main', 'Main Region'),
          ),
      })
    
    Newsletter.create_content_type(TextOnlyNewsletterContent)
    Newsletter.create_content_type(TextWithImageNewsletterContent)
  7. Add Pennyblack Models to south migration modules in your settings.py:

    SOUTH_MIGRATION_MODULES = {
        'pennyblack': 'project_name.migrations_pennyblack',
        'subscriber': 'project_name.migrations_subscriber',
    }
  8. Run schemamigrations and migrate:

    ./manage.py schemamigration --initial pennyblack
    ./manage.py schemamigration --initial subscriber
    ./manage.py migrate

Dependencies

  • Python

    • django

    • feincms

    • pyspf

    • pydns

    • pil

  • Project Settings

    • TEMPLATE_CONTEXT_PROCESSORS

      • django.core.context_processors.request

    • FEINCMS_ADMIN_MEDIA

    • feincms medialibrary musst be installed

Metadata

Release files for pennyblack 0.3.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pennyblack 0.3.5
File Size Uploaded Provenance
pennyblack-0.3.5.tar.gz 82.7 kB Without provenance Details

Release files / pennyblack-0.3.5.tar.gz

Download URL pennyblack-0.3.5.tar.gz
Size 82.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e0472d8780c3f53ab65acb9ed780be7333902f9469d327c01f4a6aa462c01750
BLAKE2b-256 checksum
How to use checksums
6b7e2acc5fd43630db8aa05d9a5fe911f37baf38f2f656373a348ddabbbf7628
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pennyblack 0.3.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page