Skip to main content

No project description provided

Project description

texsite

Pipeline Coverage PyPI License

texsite delivers great and ready-to-use page templates for the modern, flexible and user-focused web content management system Wagtail CMS backed by the popular Django web framework, both written in Python.

Based on the amazing StreamField introduced with Wagtail release 1.0, which texsite uses extensively, it has never been easier for editors to author awesome pages. Read more on how this concept works in the great blog article Rich text fields and faster horses written by Matt Westcott, lead technical developer of Wagtail.

Features

Technical requirements

New feature releases frequently add support for newer versions of underlying technologies and drop support for older ones. The compatible versions of Wagtail, Django and Python for each texsite release are:

Release Wagtail Django Python
6.0+ 7.0 LTS 5.2 LTS 3.13
5.0+ 6.3 LTS 4.2 LTS 3.9, 3.10, 3.11, 3.12, 3.13
4.0+ 4.1 LTS 3.2 LTS 3.8, 3.9, 3.10, 3.11
3.0 2.11 LTS 3.1 3.8
2.0 2.7 LTS 2.2 LTS 3.6, 3.7, 3.8
1.0 2.3 LTS 1.11 LTS 3.4, 3.5, 3.6

texsite only supports SQLite databases.

Code and contribution

The code is open source and released under the ISC License (ISCL). It is available on Gitlab and follows the guidelines about Semantic Versioning for transparency within the release cycle and backward compatibility whenever possible.

All contributions are welcome, whether bug reports, code contributions and reviews, documentation or feature requests.

If you're a developer, fork the repo and prepare a merge request:

# Prepare your environment
uv sync
git config core.hooksPath .githooks

# Running tests
uv run python -m django test --settings=tests.settings

# Code quality
uv run ruff format texsite tests
uv run ruff check texsite tests

# Translations
uv run python -m django makemessages --all
uv run python -m django compilemessages

Installation

Install texsite directly from PyPI using pip:

pip install texsite

Configuration

All configuration details can be found in texsite/settings/config.py. The available environment variables and their defaults are defined there.

We recommend using a .env file to set the environment variables. manage.py loads it automatically, and it is also recognised by Docker compose.

If you need more flexibility, you may provide your own settings module. This is done by setting the DJANGO_SETTINGS_MODULE environment variable to the path of your custom settings module.

Local development

Run the development server locally without Docker:

cp .env.example .env
mkdir -p .data
uv run python manage.py migrate
uv run python manage.py createsuperuser
uv run python manage.py runserver 127.0.0.1:8000

See the Configuration section above for available environment variables.

Docker

We provide a Dockerfile to build a production-ready image. Production routing lives outside this repository; compose.yml covers local development and pre-release testing — see it for services, ports and mounts.

docker compose run --rm cli migrate            # management commands run through `cli`
docker compose up                              # hot-reloading dev server
docker compose --profile release up --build    # prod-like image test

Multi-Tenant Hosting

texsite supports multi-tenant hosting where a single instance serves multiple customer domains. Each tenant gets their own:

  • Wagtail Site with custom root page
  • Collection for media isolation
  • User group with scoped permissions
  • Site branding (logo/favicon) via Wagtail admin

New Tenant Setup (Wagtail Admin)

  1. Create root page under the Root page
  2. Create Wagtail Site pointing to the new root page with correct hostname/port
  3. Create Collection for tenant media (Images/Documents)
  4. Create Group with permissions:
    • add_page, change_page, publish_page on root page
    • add_image, change_image, choose_image on collection
    • add_document, change_document, choose_document on collection
  5. Create users and assign to the tenant group
  6. Configure SiteBranding (Settings > Site branding)

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

texsite-6.6.0-py3-none-any.whl (920.4 kB view details)

Uploaded Python 3

File details

Details for the file texsite-6.6.0-py3-none-any.whl.

File metadata

  • Download URL: texsite-6.6.0-py3-none-any.whl
  • Upload date:
  • Size: 920.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for texsite-6.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af8270a2d4bf9a89c4aff6e04869c42c9a9ae9329b8aa0bc0ad048bae059b462
MD5 102533c3dad972b9f81bd454077f0a51
BLAKE2b-256 23f94d0c5d3f81bde236c1b09191f19cb4a026e216d974d0e2a6c5d5c69f15a7

See more details on using hashes here.

Supported by

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