Version History and Release Notes¶
Releases of SaaS Pegasus: The Django SaaS Boilerplate are documented here.
This fixes a crashing issue when resending team invitations.
Sep 8, 2021
This release adds an HTMX demo, a Teams example app, and more.
This video provides a 4-minute overview of the key features, or read on for details.
The HTMX object demo
The object demo application now has an htmx implementation. HTMX is a library that allows you to build rich, single-page, interactive experiences by adding HTML attributes.
The Teams Example app
This release also adds a Teams example app, which has Create, Read, Update, Delete (CRUD) views for an example model that is part of a team (called a “Player”).
As part of this work, a new base model class,
BaseTeamModel was added which can be extended
to create models that belong to a Team.
Additionally, two view mixin classes,
TeamAdminRequiredMixin were added,
which can be used to easily create class-based model views on Team models.
A test suite for these mixins was also added.
More details can be found in the Teams documentation.
A big thanks to Peter Cherna, who’s Pegasus example apps was a big inspiration for this example.
- Add generic breadcrumbs CSS classes compatible with Bulma, Bootstrap and Tailwind (used by teams example)
- Default all Pegasus apps to using
AutoField(see upgrade notes)
- Use f-strings instead of string templates in management commands
- Reduce indentation level in some html template files
The default ID for all Pegasus models was changed from
If you are upgrading a project using
AutoField you should not merge any changes to initial migration
files in the affected apps. Then you can either:
- To change your apps from
- To keep using
AutoField, change the setting back to
apps.pyfor all Pegasus apps.
Aug 24, 2021
This release upgrades
django-hijack from 2.3 to 3.0 and adds hijack links to the admin site.
Aug 11, 2021
This minor release fixes styling issues with Tailwind builds that were accidentally introduced in 0.16.
Aug 9, 2021
This is a grab-bag release of mostly cleanup work and bug fixes.
Please review the breaking changes closely if you are upgrading an existing project! Not doing so could lead to unexpected behavior and demo data loss!
Potentially breaking changes:
- Changed the
team_admin_requiredview decorators to no longer allow superusers to access the views. It is recommended to use the new user impersonation feature to allow superusers to access teams they don’t belong to.
user_can_administer_teamhelper functions which provided team access to superusers.
attrslibrary dependency and switched its usages to
Employeeexample data model has moved, and running
migratewill drop all of your demo
New: Improved Django form support:
- Added a Django forms implementation of the employee / object demo
form_fieldsif not using multiple-css-framework support
render_form_fieldshelper function to render an entire form. (Note: this currently only supports text-style, checkbox, and select input types.)
render_checkbox_inputto bootstrap form rendering tags
- Added a basic non-model form example
- Fix cryptography build issue affecting Heroku docker deployments
- Improve textarea styling on Bootstrap forms
- Better default styling of checkboxes in Bootstrap forms.
- Don’t require that
team_slugbe the first argument to a url to use the team-based decorator functions.
- Upgrade Django to 3.2.6
- Remove redundant
null=Truefrom user avatars
- Added more type hints
- Split object / employee example out into its own app and template folder.
- Added help text to employee example model fields
- Changed some navigation and text around the employee app example
- Remove inline style declarations from a few examples
- Added some instructions about initializing your database to the README
- Update migrations to be compatible with latest Django / Pegasus code
If you receive a warning like this when generating Database migrations:
You are trying to change the nullable field ‘avatar’ on customuser to non-nullable without a default; we can’t do that (the database needs something to populate existing rows).
It is safe to choose option 2, “Ignore for now…”.
There won’t be any NULL values in the database, since Django automatically populates
FileFields with an
Aug 6, 2021
Version 0.15 is a major release with two big features: Stripe Checkout and User Impersonation.
For 3-minute summary you can watch the video below, or read on for details.
Stripe Checkout Support
Now you can use Stripe Checkout for payments instead of - or in addition to -
the Stripe Elements-based embedded UI. Stripe Checkout support has been added to the subscriptions page, as well
as the payment example. You can build new Pegasus projects with Checkout, Elements, or toggle between them
This release also adds optional user impersonation functionality for superusers, allowing admins and support staff to “login as” another user with a few clicks. This is a great tool for troubleshooting user-specific issues. This feature depends on django-hijack and can be disabled at build time.
- Make http/https in absolute URLs (e.g. email invitations) configurable via the
- Start adding type hints to the codebase, primarily in helper functions. More coming soon!
- Added more tests for teams helper functions
- Split out
subscription/views.pyinto multiple files to make it clearer which views affect which functionality.
upgrade_subscription.htmlinto multiple files to support elements and checkout-based flows.
- Improve default string representation of user model
- Improve the default styling of select widgets (Bootstrap builds only)
- Clean up doc strings and code for team API permission helpers (teams builds only)
teams.helpersto be consistent with other apps (teams builds only)
- Fix issue with
apps/subscriptions/__init__.pynot being created for certain configurations
- Various minor cleanups of whitespace, url ordering, etc.
July 22, 2021
Another grab-bag of minor fixes and improvements.
- Reduce scope of hiding file inputs to just the profile upload form
NoNewUsersAccountAdapterto allow disabling public sign ups for an app
- Extract Bulma and Bootstrap form rendering to helper template tags
- Fix subscription details start date display (subscriptions builds only)
- Explicitly set
AutoFieldin settings to remove runtime warnings.
- Minor README improvements
- Upgrade Django to 3.2.5
Changes only affecting builds with teams enabled:
- Fix error on sign up if email passes front-end validation but fails back-end validation
/teams/URL to go to the teams management page instead of API docs
- Improve styling of teams page when no teams exist on Bootstrap
July 15, 2021
A very minor release:
- Don’t include
djstripeand associated settings in
INSTALLED_APPSif not using subscriptions
June 30, 2021
A very minor release:
- Update Django to 3.2.4
DEFAULT_AUTO_FIELDdeclaration from settings. This was causing issues with allauth migrations being generated, as a result of this issue. Until more libraries have worked around these migration issues, Pegasus will just ship with the default setting.
June 17, 2021
This release upgrades
dj-stripe to version
2.4.4 which should fix cross-environment migration issues.
Projects using a “clean” 0.14 or 0.14.1 release may have been affected by this issue in dj-stripe
makemigrations automatically generated a migration file inside the
dj-stripe library code.
Local app migrations would then add a dependency to this migration, which would not be available on other environments.
This often manifested as an error along the lines of the following when setting up a second environment:
django.db.migrations.exceptions.NodeNotFoundError: Migration .0003_auto_20210524_1532 dependencies reference nonexistent parent node ('djstripe', '0008_auto_20210521_2314')`
To fix this there are a few steps:
- You should explicitly uninstall and reinstall
dj-stripeinstead of just installing requirements to ensure the generated migration file is removed.
pip uninstall dj-stripe && pip install dj-stripe==2.4.4
- You should rebuild your own app’s migrations to no longer depend on the generated
dj-stripemigration, by deleting the bad files and re-running
makemigrationson a fresh environment.
- You will need to “fake” migrations for any existing DBs, by manually deleting relevant rows from the
django_migrationstable and then running
./manage migrate <appname> --fakefor each affected app.
Please reach out for support on Slack if you run into any issues with this, and I’m happy to help!
May 26, 2021
This is a minor release including the latest Django security updates, the official Bootstrap 5.0 version, and a few small features and fixes.
- Fix incorrectly generated
urls.pyif you built with teams and without subscriptions
- Add password confirmation field to sign up pages if configured by allauth
project_settingsexample for passing project-level settings to templates via context processor
- Remove unused
kombudependencies from requirements.
Changes affecting experimental features only:
- Slightly improved styling of Tailwind sign up page
May 19. 2021
Version 0.14 is a major release with a focus on Teams and package upgrades. It also upgrades Pegasus to Django’s 3.2 LTS release. Details are below:
- Make team name optional on signup, and auto-generate a team if none specified.
- Update team-based URL-routing to be more consistent (put all team urls behind
- Migrate teams React code to functional components / hooks
- Add URL-routing and back button support to teams page
- Restrict ability to edit/delete teams to team admins only
- Restrict ability to manage team invitations via API to team admins only
- Add manage/view team page to main team navigation
- Other minor teams JS cleanup (replace
team_nav.htmlwhen not using teams
- Improve loading screen for teams page and extract to shared component
- Upgrade all python packages to latest versions (including Django to 3.2 LTS)
- Updated settings file to the version that ships with Django 3.2
- Update formatting of requirements files to the latest version used by
- Upgrade all JS packages to latest versions
- Switch from deprecated node-sass to dart-sass
- Set base URL in React object demo from Django
- Fix doc strings of npm-related
- Add support for celery workers to Digital Ocean deployments (and updated docs)
make dbshelldocker command to get a database shell
- Remove some tailwind files that were accidentally included in non-tailwind builds
Changes affecting experimental features only:
- Improve Tailwind styling of examples, teams and other built-in pages
@tailwind/formsplug in for improved form styling
- Split Pegasus Tailwind CSS classes into a new file to mirror Bootstrap/Bulma implementations
- Fix collectstatic errors when building with tailwind and whitenoise (affected Heroku and Digital Ocean deployments)
- Remove broken landing page and pricing page examples, and point people to Tailwind UI instead
- Django added the new Default primary key field type
setting. If you wish to use the default in 3.2 you will have to add DB migrations for it. Otherwise you
can change the value of
- Bootstrap users may need to run
npm update bootstrapbefore building static assets to get all styling of the examples working again.
April 28, 2021
This is a minor release primarily focusing on an improved Docker experience and updates to the experimental TailwindCSS support:
- Update development
busterand install front-end dependencies.
Makefilewith self-documenting targets for various common operations (see docs)
- Update generated
READMEwith better Docker instructions
- Use double quotes for description and name settings to reduce issues with apostrophes
Changes affecting experimental features only:
- Properly support for using PurgeCSS with Tailwind
- Include (purged) Tailwind bundle files with Pegasus
March 10, 2021
This is a minor maintenance release with a few small changes and fixes.
- Fix Docker image when deploying to Heroko containers
- Fix SSL mixed content issues on Heroku Docker builds
body_wrapperblock for overriding the whole base template
- Label closing
endblocktags in base template
- Minor compatibility fixes to
February 24, 2021
This release adds support for the Bootstrap CSS framework and includes several changes to how the CSS files are structured in Pegasus. See the new CSS documentation for an overview of the new structure.
- Full support for Bootstrap CSS!
- Restructure CSS files, creating framework-level subfolders, splitting
site-<framework>files out, and making Sass imports implicit in the Bulma files.
- Examples CSS overhaul, converting styles to
pg-classes and adding the
- Improved UI of object demo tables on small screens.
- Remove unused “tagline” CSS styles and replace with the CSS frameworks’ vertical centering utilities.
- Update progress bar styles to use CSS variables instead of Sass variables.
- Remove unused redundant “section” classes from a number of places.
- Split profile page into multiple HTML templates.
- Remove unused
plan-taglineclasses from subscription page.
- Fixed bad reference to
subsriptions.sasswhen not building with subscriptions.
- Remove unused
- Remove redundant
- Add /404 and /500 endpoints for viewing custom 404 and 500 pages.
- Remove unnecessary raw string formatting from severeal
- Upgrade Django to
February 8, 2021
This release continues the overhaul of the Pegasus CSS and templates to include experimental support for the Bootstrap CSS framework. Details on using Bootstrap can be found here.
Changes affecting everyone:
- Fix “view subscription” page start date display, and accommodate when start date is not set in Stripe.
ACCOUNT_LOGIN_ON_EMAIL_CONFIRMATION = Trueto avoid double-login after email confirmation.
- Move navbar avatar styling to standalone
navbar.sassfile to be shared across CSS frameworks.
- Change navbar avatar class and CSS from
- Split subscription details on the “view subscription” page into its own component templates.
- Split hero section on the “upgrade subscription” page into its own component templates.
subscriptions.sass, use css variables instead of sass variables for colors.
- On subscription page, change “upgrade-features” selector from an ID to a class in HTML and CSS.
- Remove unused styles from
- Clean up whitespace in a number of files
Changes affecting experimental features:
- Booststrap CSS build! Details here.
- Building for multiple CSS frameworks now includes Bootstrap (along with Bulma and Tailwind)
- Building for Tailwind now overwrites Bulma templates instead of maintaining them in a separate directory.
January 26, 2021
This release is a set of changes laying the groundwork for future Pegasus improvements.
Existing Pegasus users will need to upgrade their installer to use the latest version
pip install --upgrade pegasus-installer)
Experimental support for Tailwind CSS
More details can be found in the Tailwind documentation.
Note: this feature is not yet fully supported and is in an experimental pre-release.
Simplified upgrade process
Pegasus now saves your configuration when you install it, to simplify the upgrade process. Instructions on upgrading can be found on the “upgrading” page.
Additional related changes and fixes
package-lock.jsonfrom Pegasus for improved compatibility across NPM / OS versions. It is recommended to run
npm installand then check in the resulting
package-lock.jsonfile to source control. More details can be found in the front end docs.
- Switch some styling from Sass variables to CSS variables (e.g. colors) for compatibility with multiple CSS frameworks
- Add a
site-base.sassfile for base Pegasus styles that aren’t dependent on any CSS framework.
- Fix issue with
- Remove no-longer-used
- Remove no-longer-used tooltip styles
- Remove unused HTML from subscriptions upgrade page and split it out into partial templates
- Change a few default settings, e.g. project and author name.
- Upgrade django to 3.1.5.
January 13, 2021
This release overhauls the Payments example to use the Stripe
and support 3DS / SCA cards.
DJSTRIPE_WEBHOOK_SECRETsetting from environment variable if available
If you are upgrading from a previous installation, you may need to change
the following two values in
DJSTRIPE_FOREIGN_KEY_TO_FIELD = 'id' # change to 'djstripe_id' if not a new installation DJSTRIPE_USE_NATIVE_JSONFIELD = True # change to False if not a new installation
December 17, 2020
- Fixes to subscription workflow when using a trial period - automatically refresh page after card is accepted and support 3D-Secure validation for credit cards when using a trial.
December 9, 2020
- Fix bug in development Dockerfile from a new OS dependency introduced by the
December 7, 2020
This release is a grab-bag of fixes and upgrades based on recent feedback.
- Force users to reconfirm their email when changing it and email verification is enabled
- Switch from
mini-css-extract-pluginfor CSS handling in Webpack
assets/site.jsto support more styles in the future.
- Use randomly generated identicons for users instead of a default empty profile picture
.env.productionso they don’t have to be copied to get running (Docker builds only)
- Clean up payments UI a little
- Remove accidentally included
team_admin.htmltemplate when not building with teams
- Remove accidentally included
Dockerfile.devtemplate when not building with Docker
- Remove unused CSS classes from examples
- Upgrade various NPM packages to latest versions
December 2, 2020
This release adds native support for deploying to Digital Ocean app platform. See the deployment guide for details.
- Remove duplicate
- Rename development
Dockerfile.devfor clarity and ease of deployment to other platforms
- Fix SSL / mixed content errors when deploying on Google Cloud Run
Nov 17, 2020
This release adds experimental native support for deploying to Google Cloud Run. More details can be found in the deployment guide.
- Fix static file references to favicons.
prod-requirements.txtto be consistent across platforms (Heroku builds only)
- Switch production Docker images from Python-alpine to Python-slim (Docker builds only)
Nov 10, 2020
This release adds native support for deploying to Heroku using Docker containers. More details can be found in the new deployment guide.
Additional minor updates:
- Allow requirements to load from multiple sources when using Docker
- Add static directories and config files to
Nov 5, 2020
Oct 28, 2020
Oct 26, 2020
This is largely a maintenance release with mostly minor updates and fixes, but there are enough library upgrades that it warrants a version bump.
- Upgrade all Python packages including upgrading to Django 3.1.2
- Upgrade all npm packages
- Add a new API for products and metadata at
/subscriptions/api/active-products/. Also includes adding some serialization classes and helper functions to subscriptions models. Subscriptions only.
- Fix a bug where clicking on “Dashboard” didn’t always take you to the right team.
Also set team ID in the request session so it can be accessed across requests, and
get_default_teamhelper function to pull the last/current team from a request. Teams only.
- Fix default styling of textarea widgets in Django forms
has-vcentered-cellstable formatting class to center table rows, and use in teams UI and object lifecyle demos
- Remove unnecessary
subscriptions.sassfile when Pegasus is built without subscriptions enabled
Oct 14, 2020
This release is a large overhaul of the React example that ships with Pegasus, including:
- Add url-routing support. Add/edit URLs now update and are linkable. This also enables back button support
- Add validation feedback missing / bad data
- Switch all components from using classes to hooks
- Split React components out into their own files
- Better loading UX
Other minor updates:
- Upgrade Django to 3.0.10 (3.1 support coming soon)
- Generate random
SECRET_KEYfor each new installation
- Upgrade to Bulma 0.9.0
- Remove some spacing utility classes in favor of the ones that ship with bulma
Existing Pegasus users will need to upgrade the installer to run this.
pip install --upgrade pegasus-installer>=0.0.2
Sep 4, 2020
- Fix default styling of number inputs in forms.
Trueif using email confirmation.
- Fix issue building front end on certain newer versions of nodejs/npm
Aug 31, 2020
This release fixes an edge case in the invitation accepting logic that didn’t work if a user left the page and came back later.
Aug 24, 2020
A minor maintenance/bugfix release:
- Fixed a bug in the invitation workflow that prevented invitations from being accepted
when creating accounts with social logins. Note that this requires changing the
- Make site branding in the navigation stay visible on mobile devices
- Make it more obvious that
settings.SECRET_KEYshould be overridden.
- Upgrade Django to 3.0.9
Aug 21, 2020
Stripe billing portal integration is here!
You can now use Stripe’s new customer portal to manage subscriptions in your app.
Supported operations and configurations include upgrading and downgrading subscriptions, subscription cancellations (both immediately, and at period end), and subscription renewals.
Additional documentation can be found in the subscription docs.
Details and other changes:
- Added “manage billing” redirect to subscription pages if you have an active subscription, which goes to the Stripe customer portal
- Added webhook functionality to sync subscription changes and cancellations made via the Stripe portal
- Removed built-in “Cancel” option and supporting code.
stripelibrary to version
- Removed the
CustomUserobject. Customers are now always accessed via their associated subscriptions.
- Removed a lot of no-longer-needed code from
SubscriptionModelMixinrelated to accessing subscriptions from the
.customerfield. References to
.stripe_subscriptionshould be changed to simple
- Fixed bug where “http://” was incorrectly assigned to the
Site.domainobject (fixes issues using
July 16, 2020
This is another minor release with mostly small fixes and updates to the front end.
- Added number formatting of Salary to object demo examples
- Fixed styling of number form inputs
- Removed unnecessary imports from
- Fixed incorrect distinction between
- Upgraded React to 16.13.1
- Moved React object lifecycle example to a
- Started splitting up React object lifecycle demo into multiple files, and refactoring it to use hooks
- Renamed React object lifecycle example bundle file from
- Removed unused “bower_components” exclusion in
July 13 2020
- Upgraded to Django 3.0.7
- Fixed display of renewal details in subscription view to work with the latest Stripe Prices API
- Added ability to resend invitations from the team management page
- Added sort order to team member list (by email address)
- Cleaned up teams JavaSript (removed console logging statements, updated whitespace, removed commented code)
June 30 2020
- Improved styling of Stripe credit card forms in subscriptions and payments examples
- Fixed bug in subscriptions where not setting a default plan prevented the UI from working
- Fixed bug where monthly subscriptions would not work if you also had a quarterly or 6-month price configured
- Changed the order of some examples in examples home page and navigation
June 17 2020
- Added ability to cancel a Subscription directly on the site. Demo (you have to create a Subscription first)
- Don’t show password change links if using social authentication (thanks Yaniv!)
June 11, 2020
Pegasus now supports Vue.js!
Version 0.7 adds a Vue.js implementation of the Object Lifecycle demo so you can start with a foundation of either React or Vue.
Membershipinline admin editing to
Teamsmodel (thanks Troels!)
- Added a few more spacing utility css classes to
June 5, 2020
0.23.0to fix installation version conflict.
May 26, 2020
This release begins the move of Pegasus’s core functionality out of the “pegasus” app and into the user-defined apps. It’s a relatively big release from a code perspective, although there is very little new / changed in terms of functionality.
The philosophy guiding this change is “your starting code base should be as understandable as possible”.
Historically, Pegasus has attempted to separate “Pegasus-owned” files from “user-owned” files. The thinking behind this structure was that Pegasus upgrades and code merges would be as easy as possible since - in theory - users would not need to modify anything in the “Pegasus-owned” space.
In practice, the line between “Pegasus-owned” and “user-owned” was fuzzy, and customizing an application often required editing files in the “Pegasus-owned” space. So the benefit was not realized.
Furthermore, this split caused the initial codebase to be more confusing, since core functionality was split across two places.
Changes related to the restructure above include:
- Moved all base templates from
- Moved team invitation templates from
pegasus/apps/usersand all related code into
pegasus/apps/teamsand all related code into
pegasus/apps/componentsand moved code to more specific apps - further details below
promote_user_to_superusermanagement command into
bootstrap_subscriptionsmanagement command into
google_analytics_idcontext processor to web app
meta.pyfrom pegasus app to web app
apps.utilsand moved most of
apps.utilsand renamed to
- Removed unused
stripe.pyfile (replacing functionality with equivalent functions in
- Removed “Pegasus” from API url names
- Moved non-example JS imports out of
- Lowercased (and kebab-cased) all JS file names for consistency
- Moved sass files from
- Renamed various layout classes, e.g.
pegasus-message, etc. to
- Removed unused
Other changes and fixes include:
- Fix accepting an invitation if you’re already signed in
- Remove subscription-related fields from team and user models if not using subscriptions
- Only ship base migration files for users and teams, and have applications manage their own migrations
- Improved checks and error-handling around accepting invitations multiple times
bulmaCSS framework to
npm audit fixto update other JS library dependencies
pip-toolsand other packages in
- Added backend check to the payments example, to show how to prevent client-side exploits
- Improve password reset email copy
- Externalized styles on progress bar demo
A Note on Database Migrations¶
Historically, Pegasus has shipped with complete database migrations. However, maintaining a set of migrations for each possible Pegasus configuration or forcing all configurations to use the same DB schema has proven unwieldy. Thus, migrations are now expected to be managed outside of Pegasus.
For new users, the only change is that prior to running
./manage.py migrate for the first time,
you must first run
For existing users you can either keep your current migrations folder, or you can run
./manage.py makemigrations and then
./manage.py migrate --fake. If you have changed the user or team
models, then you should keep your current folder.
May 19, 2020
- Fixed default Postgres DB settings (adding host and port)
- Removed Stripe webhooks from project urls if not using subscriptions
- Fixed but where subscription and teams templates were still being included even if not enabled for a project
- Cleaned up progress bar demo
- Switched from
constin a few places
- Removed debug logging statements
May 7, 2020
Version 0.5.1 is a minor maintenance release with a few minor bug fixes and bits of cleanup:
- Upgraded Django to 3.0.5
- Fixed bug where certain input types were getting overridden in Django Forms (thanks Yaniv for reporting!)
- Fixed bug with Object Lifecycle and Charts demos not working on Team installations (thanks Greg for reporting!)
admin.pyfiles to use the
April 17, 2020
This is the biggest release to Pegasus since it’s launch. Read below for all the details.
Added the Stripe Subscriptions feature.
Documentation for subscriptions can be found here.
- Added a
CustomUserobjects, and a
SubscriptionModelMixinhelper class for accessing / checking subscription status on a model.
Pegasus.jsand made different modules available in front end code (see subscriptions upgrade page example usage).
Sass / CSS changes¶
- Added a few margin helper classes (e.g.
Small fixes and changes:¶
- Moved app-specific templates from inside the apps to global templates directory as recommended by Two Scoops of Django
- Remove redundant raw prefix on some
- Reduced some duplicate access to
teamobject when already available via the
- Made team permission template tags more consistent with rest of site (also allow access to superusers)
pegasus_settingscontext processor. All config is now handled at installation time instead of by settings variables.
- Catch Stripe card errors in the payments example
- Upgraded various
- Upgraded Bulma to 0.8.0