4
0
Bifurcation 1
This project has been migrated to https://framagit.org/cliss21/wagtail-webradio
Ce dépôt a été archivé le 2023-06-07. Vous pouvez voir ses fichiers ou le cloner, mais pas ouvrir de ticket ou de demandes d'ajout, ni soumettre de changements.
 
 
 
 
 
 
Aller au fichier
Jérôme Lebleu 54b50ec567 release 0.1.0 2022-02-14 15:19:33 +01:00
tests feat(models): validate Podcast.sound_url by opening it 2022-02-03 19:06:07 +01:00
wagtail_webradio feat(models): validate Podcast.sound_url by opening it 2022-02-03 19:06:07 +01:00
.gitignore first commit 2021-08-04 17:30:51 +02:00
CHANGELOG.md release 0.1.0 2022-02-14 15:19:33 +01:00
LICENSE feat(build): create a void pip package 2021-08-05 10:23:39 +02:00
MANIFEST.in ref: rename wagtailwebradio to wagtail_webradio 2021-11-25 11:14:16 +01:00
Makefile ref: rename wagtailwebradio to wagtail_webradio 2021-11-25 11:14:16 +01:00
README.md doc(readme): document the installation and configuration 2022-02-14 15:19:33 +01:00
pyproject.toml build: remove setup.py and deprecated setuptools-scm usage 2022-02-14 15:19:33 +01:00
setup.cfg build: remove setup.py and deprecated setuptools-scm usage 2022-02-14 15:19:33 +01:00

README.md

wagtail-webradio

Manage your web radio - e.g. podcats, programs - in Wagtail.

Warning! This project is still early on in its development lifecycle. It is possible for breaking changes to occur between versions until reaching a stable 1.0. Feedback and pull requests are welcome.

Requirements

This package requires the following:

  • Wagtail >=2.15
  • Django (3.1, 3.2)
  • Python 3 (3.7, 3.8, 3.9)

Installation

  1. Install using pip:
    pip install wagtail-webradio
    
  2. Add wagtail_webradio to your INSTALLED_APPS setting:
    INSTALLED_APPS = [
        # ...
        'wagtail_webradio',
        # ...
    ]
    
  3. Run python manage.py migrate to create the models

Configuration

WEBRADIO_VALIDATE_PODCAST_URL

Default: True

Whether to validate the song URL of a Podcast on creation and edition. It just ensures that the URL can be fetched, nothing more.

Development

Quick start

To set up a development environment, ensure that Python 3 is installed on your system. Then:

  1. Clone this repository
  2. Create a virtual environment and activate it:
    python3 -m venv venv
    source venv/bin/activate
    
  3. Install this package in develop mode with extra requirements:
    pip install -e .[test]
    

Contributing

The Python code is formatted and linted thanks to flake8, isort and black. To ease the use of this tools, the following commands are available:

  • make lint: check the Python code syntax and imports order
  • make format: fix the Python code syntax and imports order

The tests are written with pytest and code coverage is measured with coverage. You can use the following commands for that:

  • make test: run the tests and output a quick report of code coverage
  • make coverage: run the tests and produce an HTML report of code coverage

When submitting a pull-request, please ensure that the code is well formatted and covered, and that all the other tests pass.

License

This extension is mainly developed by Cliss XXI and licensed under the AGPLv3+. Any contribution is welcome!