Skip to main content

Instant Article for Masonite

Project description

Instant Articles

GitHub Workflow Status PyPI Python Version GitHub release (latest by date including pre-releases) License star Code style: black

If you are seeking package for generating instant article or feeds in Masonite then yes, this package is for you.

This helps you generate facebooks instant articles and also regular feeds with enough customizations you might need.


pip install masonite-instant-article


Add InstantArticleProvider to your project in config/

# config/
# ...
from instant_article.providers import InstantArticleProvider

# ...
    # ...
    # Third Party Providers
    # ...

Then you can publish the configuration by doing:

python craft package:publish instant_article

Update Configurations

You need to define options in your instant_article configuration file inside config directory.

# config
    "force_validate": False,
    "feed_details": {
        "your-custom-route-name.xml": {
            'model': 'path-to-your-model-class',
            'title': '',
            'description': '',
            'lang': 'en-us',
            'brand': '',
            'type': 'instant-article' # feed, instant-article

# Example
    "force_validate": False,
    "feed_details": {
        "blogs-rss.xml": {
            'model': 'app.models.Blog',
            'title': 'Blog Feed',
            'description': '',
            'lang': 'en-us',
            'brand': '',
            'type': 'instant-article' # feed, instant-article
        "news-rss.xml": {
            'model': 'app.models.News',
            'title': 'News Feed',
            'description': '',
            'lang': 'en-us',
            'brand': '',
            'type': 'instant-article' # feed, instant-article

# Above feeds can be access from:


from instant_article.interfaces.instant_article_interface import InstantArticleInterface
from instant_article.models.instant_article import InstantArticle

class YourModel(Model, InstantArticleInterface):

    def get_feed_items():
        return YourModel.all() # can be any query returning proper values

    def format_feed(self):
        return InstantArticle.create({
            'id':, # required | integer
            'title':, # required | string
            'subtitle': '', # nullable | string
            'kicker': '', # nullable | string
            'summary': '', # required | string
            'description': '', # required | string
            'cover': '', # nullable | string
            'updated': self.updated_at, # required | date
            'published': self.created_at, # required | date
            'link': '', # full url to item...
            'author': '' # nullable | email | string

Your project is now ready to go :+1:.


Please read the Contributing Documentation here.


masonite-filemanager is open-sourced software licensed under the MIT license.

Project details

Download files

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

Source Distribution

masonite-instant-article-0.1.2.tar.gz (23.7 kB view hashes)

Uploaded Source

Built Distribution

masonite_instant_article-0.1.2-py3-none-any.whl (11.1 kB view hashes)

Uploaded Python 3

Supported by

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