Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Editable text for PSU Django apps

Project description

PSU-Infotext

Reusable Django app specifically for PSU's custom-built web applications.
Provides the ability to include user-editable text in any site using the psu_base plugin.
Includes:

  • Template tags for editable text
  • WYSIWYG interface for editing the text

Quick Start

Dependencies

The following dependency is REQUIRED and must be installed in your app:

Installation

pip install psu-infotext

Configuration

  1. Configure psu-base in your Django app
  2. Add PSU-Infotext to your INSTALLED_APPS in settings.py:
    INSTALLED_APPS = [
       ...
       'psu_base',
       'psu_infotext',
    ]
    
  3. Configure your app's top-level urls.py to include Infotext views:
    urlpatterns = [
        ...
        path('infotext/', include(('psu_infotext.urls', 'psu_infotext'), namespace='infotext')),
    ]
    

Usage

Usage of the psu-infotext app is documented in Confluence.

For Developers

The version number must be updated for every PyPi release. The version number is in psu_infotext/__init__.py

Document Changes

Record every change in docs/CHANGELOG.txt Document new features or significant changes to existing features in Confluence.

Publishing to PyPi

  1. Create accounts on PyPi and Test PyPi
  2. Create ~/.pypirc
    [distutils]
    index-servers=
        pypi
        testpypi
    
    [testpypi]
    repository: https://test.pypi.org/legacy/
    username: mikegostomski
    password: pa$$w0rd
    
    [pypi]
    username: mikegostomski
    password: pa$$w0rd
    
  3. Ask an existing developer to add you as a collaborator - test and/or prod
  4. python setup.py sdist bdist_wheel --universal
  5. twine upload --repository testpypi dist/*
  6. twine upload dist/*
  7. Tag the release in Git. Don't forget to push the tag! Example:
git tag 0.1.2
git push origin 0.1.2 

Project details


Download files

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

Files for psu-infotext, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size psu_infotext-0.4.1-py2.py3-none-any.whl (20.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size psu-infotext-0.4.1.tar.gz (9.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page