LOOKING FOR NEW MAINTAINER - Quokka is a Content Management System - `docker run --rm -it -p 5000:5000 quokka/quokka`

Overview

Quokka

quokka

The Happiest CMS in the world

Quokka is a Content Management Framework written in Python.

A lightweight framework to build CMS (Content Management System) as websites, portals, blogs, applications and anything related to publishing content to the web.

Quokka is not limited to CMS area, it is also possible to create Quokka extensions to provide any kind of web application based on Python and Flask.

Quokka can also (optionally) generate a static website from the contents generated in its admin interface.

Features

  • Web based content management admin interface
  • Multiple content formats (markdown, rst, html, plaintext)
  • Compatibility with any of the Pelican Themes
  • Flat file NoSQL database TinyDB or optionally MongoDB for scale deployments
  • Host the Quokka on server or generate a static website
  • Extensible via modules/plugins
  • Powered by Python, Flask, Flask-Admin, TinyMongo and Pelican Themes

Demo

Use this if you want to see how Quokka works

docker run --rm -it -p 5000:5000 quokka/quokka

Go to http://localhost:5000/admin and login using admin/admin

Quick Start

NOTE: QuokkaCMS requires Python 3.6+

To install and run for development mode

Use this if you want to contribute to quokka, PyPi releases will be provided soon.

git clone https://github.com/rochacbruno/quokka
cd quokka
python3 -m venv venv
. venv/bin/activate
pip3 install --upgrade pip
make install
make adduser
make devserver

then access http://localhost:5000 and http://localhost:5000/admin edit the quokka/project_template/quokka.yml and start contributing to the code!

NOTE: In dev mode the project in quokka/project_template/ is used and a database is created inside it.

To install for use/deployment

NOTE: this project is a Work In Progress, consider installing in development mode

python3 -m venv venv
. venv/bin/activate
pip3 install --upgrade pip
pip3 install -e git+https://github.com/rochacbruno/quokka.git#egg=quokka
quokka init mysite
cd mysite
quokka adduser
quokka runserver

Using Quokka CMS

Start a project

$ quokka init NewWebsite --theme=flex --modules=gitpages,heroku
...
? Quokka project created ?
? Name: NewWebsite
? Location: /tmp/newwebsite
? Template: default
? Themes: flex theme installed
? Modules: [gitpages, heroku] installed
? Config: Config file written in /tmp/newwebsite/quokka.yml
➡ Go to /tmp/newwebsite
⚙ run `quokka runserver` to start!
? Check the documentation on http://quokkaproject.org
? Happy Quokka! ?

YES! it outputs emojis ?

The above command will generate your project in myproject folder as:

.
├── databases        # TinyDB database files (gitignored)
├── modules          # Custom modules to load on EXTRA_EXTENSIONS
├── static_build     # output static site
├── themes           # Front-end Themes (Pelican and Quokka Themes supported)
├── uploads          # Media uploaded via admin
├── .gitignore       # gitignore to exclude sensitive files
├── quokka.yml       # Project settings
├── .secrets.yml     # To store keys, tokens and passwords (gitignored)
└── wsgi.py          # To deploy `gunicorn wsgi:app`

You can optionally pass arguments:

Choose existing theme (the default is Malt)

quokka init mywebsite --theme http://github.com/user/theme

Install modules

quokka init mywebsite --theme http://github.com/user/theme --modules="commerce,foo"

the above looks for quokka_commerce and quokka_foo in PyPI and installs it

Set important configurations

quokka init mywebsite --theme http://github.com/user/theme --config="auth_enabled=false"

That is optional, you can to edit quokka.yml to tune your settings.

Create an admin user

quokka adduser

Run your website

quokka runserver --port 5000

Access admin interface

http://localhost:5000/admin

Access your site

http://localhost:5000

Deploy

You can deploy your Quokka Website in a WSGI server

Check the wsgi.py and refer to it when deploying in wsgi servers.

cd myproject
gunicorn wsgi:app -w 4 -b "0.0.0.0:8000"

An example of supervisord config

[program:quokka]
command=/myproject/venv/bin/gunicorn wsgi:app -w 4 -b "0.0.0.0:8000"
directory=/myproject

For more information read Gunicorn documentation

Publish Static HTML website

NOTE: To generate a static website all user management, keys and passwords will be removed from settings.

You can generate a static HTML website to host anywhere

Once you have your website running locally you can easily generate a static HTML website from it.

$ quokka publish --static [--output path]
Generating static HTML website on ./static_build folder

Once you have a ./static_build folder populated with static website you can deploy it using SCP, FTP or git, it is a full static website.

Deploying to github pages from command line

NOTE: You need either ssh key access to github or it will ask login/password

quokka publish --static --git=rochacbruno/mysite --branch=gh_pages

The above is also available in admin under 'publish' menu.

Deploying via SCP

quokka publish --static --scp --dest='me@hostname:/var/www/mysite' [--sshkey ~/.ssh/key] [--password xyz]
password : ...

Deploying to Heroku

This requires heroku client installed, if Procfile is not found it will be generated

quokka publish --static --heroku --options

Deploying via FTP

quokka publish --static --ftp --host='ftp://server.com' --dest='/var/www/mysite'

Load database from remote deployment (only for TinyDB)

When you publish a static website along with the static files the database also goes to the server under the databases/ folder only as a backup and snapshot.

You can load that remote database locally e.g: to add new posts and then re-publish

quokka restoredb --remote --git=rochacbruno/mysite
Creating a backup of local database...
Downloading remote database
Restoring database..
Done...

Now you can run quokka runserver open your localhost:5000/admin write new content and then Publish website again using command line or admin interface.

NOTE: If you want to restore a local database use --local and --path path/to/db

Using MongoDB

You can choose to use MongoDB instead of TinyDB, That is useful specially if you deploy or local instance has more than one admin user concurrently and also useful if you want to install plugins which support MongoDB only (because it relies on aggregations and gridfs)

You only need a running instance of Mongo server and change quokka.yml:DB on your project from:

quokka:
  DB:
    system: tinydb
    folder: databases

to:

quokka:
  DB:
    system: mongodb
    name: my_database
    host: 127.0.0.1
    port: 2600

Then when running quokka again it will try to connect to that Mongo Server.

With that you can deploy your site on wsgi server or can also generate static website.

Running mongo in a Docker container

cd your_quokka_project_folder
docker run -d -v $PWD/databases:/data/db -p 27017:27017 mongo
# wait some seconds until mongo is started
quokka runserver

Contributing to Quokka CMS Development

Do you want to be part of this open-source project?

Take a look at Contributing Guidelines

Setup a contributor environment

Ensure you have Python3.6+ fork this repo and:

git clone https://github.com/$YOURNAME/quokka
cd quokka

# create a Python3.6 virtual env
make create_env

# activate the venv
. venv/bin/activate

# install Quokka in --editable mode (using pbr)
make install

# Create a new admin user
make adduser

# run quokka
make devserver

Access http://localhost:5000/admin and http://localhost

ROADMAP

This list is available on https://github.com/rochacbruno/quokka/issues

This is the list of tasks to be completed until 1.0.0 can be released. support 100% coming only for malt and bootstrap3 themes

Screenshots

The main Admin page

home cms

Pelican themes compatible

An article showing in Malt theme

start contributing to quokka project my site

The same article using Bootstrap 3 theme

start contributing to quokka project my site2

See more on screenshots on https://github.com/rochacbruno/quokka/issues/647

Start contributing right now!

Comments
  • Support to python3

    Support to python3

    All tests are passing, but I'm referencing some own repositories while I not receive a feedback about my others PR.

    I've created a repository for the twill with support to python3 (2to3) and I would like to pass this repository to the quokkaproject profile, if you want...of course.

    opened by alexandre 14
  • werkzeug

    werkzeug "GET /admin/static/admin/js/actions.js HTTP/1.1" 404 -

    Is anyone still alive around here is this project being worked on? :) Another problem I have is it never seems to find this file so I cant tick and delete in the admin interface. The only trace of that file I see is in the below directory. I tried moving it around but it didnt work. Where is it supposed to be and why is it missing or looking in the wrong spot? Thanks. /home/quokkaenv/quokka/quokka/themes/cosmo/static/admin/js/actions.js

    opened by eurabilis 13
  • No handlers could be found for logger

    No handlers could be found for logger "root"

    I'm running the Quokka CMS throught Docker containers, like instructed https://github.com/quokkaproject/docker-gunicorn-supervisor

    When I run:

    docker-compose run --rm quokka python manage.py populate

    This problem occurrs in manage.py (https://github.com/rochacbruno/quokka/blob/9a30d629a6e4877f952342eac7472e0bc91efa92/manage.py)

    ☁  docker-gunicorn-supervisor [master] docker-compose run --rm quokka python manage.py populate
    Starting dockergunicornsupervisor_mongo_1
    No handlers could be found for logger "root"
    Traceback (most recent call last):
      File "manage.py", line 9, in <module>
        app = create_app()
      File "/quokka/quokka/__init__.py", line 24, in create_app
        configure_extensions(app, admin_instance or admin)
      File "/quokka/quokka/ext/__init__.py", line 18, in configure_extensions
        db.init_app(app)
      File "/usr/lib/python2.7/site-packages/flask_mongoengine/__init__.py", line 134, in init_app
        connection = _create_connection(settings)
      File "/usr/lib/python2.7/site-packages/flask_mongoengine/__init__.py", line 89, in _create_connection
        return mongoengine.connect(conn.pop('db', 'test'), **conn)
      File "/usr/lib/python2.7/site-packages/mongoengine/connection.py", line 173, in connect
        return get_connection(alias)
      File "/usr/lib/python2.7/site-packages/mongoengine/connection.py", line 135, in get_connection
        raise ConnectionError("Cannot connect to database %s :\n%s" % (alias, e))
    mongoengine.connection.ConnectionError: Cannot connect to database default :
    [Errno 111] Connection refused
    

    Your operating system name and version.

    • Operational System: Ubuntu 14.04.4 LTS
    opened by erichideki 12
  • can't run manage accounts_createsuperuser

    can't run manage accounts_createsuperuser

    The First (venv) D:\Person\study\quokka>python manage.py accounts_createsuperuser python: can't open file 'manage.py': [Errno 2] No such file or directory. There isn't manage.py file.

    Second: I try to pip install manage .finish manage module setup. (venv) D:\Person\study\quokka\quokka>manage populate Usage: manage [OPTIONS] COMMAND [ARGS]...

    Error: No such command "populate". image

    opened by javago 11
  • In hopes of getting myself rid of #204 Im doing a complete reinstall now getting

    In hopes of getting myself rid of #204 Im doing a complete reinstall now getting "ImportError: No module named PyRSS2Gen"

    In hopes of getting myself rid of #204 Im doing a complete reinstall now getting "ImportError: No module named PyRSS2Gen"

    But I have the module installed. Can I get a hand thanks.

    Traceback (most recent call last): File "./wsgi.py", line 8, in application = DispatcherMiddleware(create_app(), { File "./quokka/init.py", line 48, in create_app from .ext import configure_extensions File "./quokka/ext/init.py", line 13, in from . import (generic, babel, blueprints, error_handlers, context_processor s, File "./quokka/ext/views.py", line 6, in from quokka.core.views import ContentDetail, ContentList, TagList File "./quokka/core/views.py", line 6, in import PyRSS2Gen as pyrss ImportError: No module named PyRSS2Gen Tue Jun 2 15:19:07 2015 - unable to load app 0 (mountpoint='') (callable not fo und or import error)

    (venv)root@sid:/var/log/uwsgi/app# pip install PyRSS2Gen Requirement already satisfied (use --upgrade to upgrade): PyRSS2Gen in /usr/locl/lib/python2.7/dist-packages (venv)root@sid:/var/log/uwsgi/app#

    opened by eurabilis 11
  • where is the repo of flask-htmlbuilder project?

    where is the repo of flask-htmlbuilder project?

    When I want to install the dependencies with requirements I have this error HTTP error 404 while getting https://github.com/majorz/flask-htmlbuilder/tarball/master

    opened by zakfriend 11
  • Cannot delete post, MongoDB error `Id: This field is required`

    Cannot delete post, MongoDB error `Id: This field is required`

    I cannot delete posts...I get the above error. The best I can do is "not publish" and hide from the channels. Any idea how to fix easily? It's kind of annoying...

    image

    opened by blakev 10
  • replace flask-script with click

    replace flask-script with click

    manage.py

    # coding: utf-8
    
    import click
    import os
    
    plugin_folder = os.path.join(os.path.dirname(__file__), 'commands')
    
    
    class Manager(click.MultiCommand):
    
        def list_commands(self, ctx):
            rv = []
            for filename in os.listdir(plugin_folder):
                if filename.endswith('.py'):
                    rv.append(filename[:-3])
            rv.sort()
            return rv
    
        def get_command(self, ctx, name):
            ns = {}
            fn = os.path.join(plugin_folder, name + '.py')
            with open(fn) as f:
                code = compile(f.read(), fn, 'exec')
                eval(code, ns, ns)
            return ns.get('main', ns.get('cli', ns.get('command')))
    
        def format_help_text(self, ctx, formatter):
            if self.help:
                #formatter.write_paragraph()
                with formatter.indentation():
                    formatter.write(self.help)
    
    
    if __name__ == '__main__':
        Manager(
            help="""
            Subcommands are loaded from the commands folder dynamically.
            File located in commands/<name>.py containing a click.command:
    
            Example:
            import click
            @click.command()
            @click.option(....)
            def main():  # name can be main, cli or command
                click.echo("Do whatever you want")
    
            The file name will be the command name
            """
        )()
    
    enhancement MEDIUM 
    opened by rochacbruno 10
  • crash

    crash

    221.238.196.47 - - [21/Aug/2014 13:46:52] "GET /admin/post/?sort=3&page=6 HTTP/1.1" 200 - Traceback (most recent call last): File "/usr/local/python/lib/python2.7/SocketServer.py", line 295, in _handle_request_noblock self.process_request(request, client_address) File "/usr/local/python/lib/python2.7/SocketServer.py", line 321, in process_request self.finish_request(request, client_address) File "/usr/local/python/lib/python2.7/SocketServer.py", line 334, in finish_request self.RequestHandlerClass(request, client_address, self) File "/usr/local/python/lib/python2.7/SocketServer.py", line 653, in init self.finish() File "/usr/local/python/lib/python2.7/SocketServer.py", line 712, in finish self.wfile.close() File "/usr/local/python/lib/python2.7/socket.py", line 279, in close self.flush() File "/usr/local/python/lib/python2.7/socket.py", line 303, in flush self._sock.sendall(view[write_offset:write_offset+buffer_size]) error: [Errno 32] Broken pipe 221.238.196.47 - - [21/Aug/2014 13:46:53] "GET /admin/post/?sort=3&page=6 HTTP/1.1" 200 - Traceback (most recent call last): File "/usr/local/python/lib/python2.7/SocketServer.py", line 295, in _handle_request_noblock self.process_request(request, client_address) File "/usr/local/python/lib/python2.7/SocketServer.py", line 321, in process_request self.finish_request(request, client_address) File "/usr/local/python/lib/python2.7/SocketServer.py", line 334, in finish_request self.RequestHandlerClass(request, client_address, self) File "/usr/local/python/lib/python2.7/SocketServer.py", line 653, in init self.finish() File "/usr/local/python/lib/python2.7/SocketServer.py", line 712, in finish self.wfile.close() File "/usr/local/python/lib/python2.7/socket.py", line 279, in close self.flush() File "/usr/local/python/lib/python2.7/socket.py", line 303, in flush self._sock.sendall(view[write_offset:write_offset+buffer_size]) error: [Errno 32] Broken pipe

    quokka crashed.

    opened by luochun-95 9
  • Unable to install - import errors from flask_misaka

    Unable to install - import errors from flask_misaka

    I was unable to install Quokka:

    First, i faced problems on Windows 7: bcrypt was not installed among other packages, (i solved this: i found 0.3.1 version compiled for windows.)

    Second, when run 'python manage.py populate' i got an error cannot import HTML_ESCAPE. I solved this by commenting its import in file d:\WinPython-32bit-2.7.5.1\python-2.7.5\Lib\site-packages\flask-misaka.py (i know that is bad way). Then i saw the same errors, so i commented imports

    TABLE_ALIGNMASK,

    #TABLE_ALIGN_C,
    #TABLE_ALIGN_L,
    #TABLE_ALIGN_R,
    #TABLE_HEADER
    

    and a little below in this file:

    ALIAS_RENDER = { #'escape': HTML_ESCAPE,

    And only after that i was able to install and runserver. All works, except http://127.0.0.1:5000/admin/mediagalleryview/ , http://127.0.0.1:5000/admin/postview/ , http://127.0.0.1:5000/admin/linkview/ , http://127.0.0.1:5000/admin/channelview/ - on these pages i got the same error:

    jinja2.exceptions.UndefinedError

    UndefinedError: 'quokka.modules.posts.admin.PostAdmin object' has no attribute '_get_filter_dict'

    opened by GraphGrailAi 9
  • Create Home To quokaproject.org

    Create Home To quokaproject.org

    Create Home To quokaproject.org

    Like: http://gitlab.org/

    Using: http://foundation.zurb.com/ http://www.getuikit.com/ http://bootswatch.com/cosmo/ http://metroui.org.ua/ https://wrapbootstrap.com/themes/landing-pages ia-no.1-metro-bootstrap-theme-WB07F9G8L http://codecanyon.net/item/metro-help-desk-support-tickets/full_screen_preview/3281394 http://codecanyon.net/item/melonhtml5-metro-ui/2986068?ref=sdeering

    opened by jniltinho 8
  • Change version of `dynaconf` in `requirements.txt`

    Change version of `dynaconf` in `requirements.txt`

    Description

    With the release of library dynaconf version 2.0, the quokka installation broke.

    Then we must change the version of requirements.txt

    dynaconf>=1.0.0,<=1.2.1
    

    Reference

    Dynaconf 2.0.0

    opened by cesarbruschetta 0
  • TODO: list from quokka/quokka/core/content/models.py

    TODO: list from quokka/quokka/core/content/models.py

    these todo list was removed from code source: TODO: get metadata from database TODO: implement libratar/gravatar return { 'cover': 'foo', 'author_gravatar': 'http://i.pravatar.cc/300', 'about_author': 'About Author', 'translations': ['en'], 'og_image': 'foo', 'series': 'aa', 'asides': 'aaa' }

    opened by marcosptf 2
  • fixing XSS vulnerability

    fixing XSS vulnerability

    im working to fix the issue #675 ;

    pr enable to merge: ->quokka/utils/text.py was create a new function to validate and remove any tags from string; remove_tags_from_string(); ->tests/utils/test_text.py was added test to neew function created: test_remove_tags_from_string();

    Att, @marcosptf

    opened by marcosptf 2
Releases(0.2.1)
  • 0.2.1(Jul 20, 2016)

  • 0.2.0(Dec 7, 2015)

    This version has an unique core.models which leads to cyclic imports problem, it works but makes module development limited, in newer version it has been split up in different model files.

    This version does not have namespace for routes, this leads to name colision, in this version you use in example url_for('tag') but in newer versions you use url_for('quokka.core.tag') and quokka.modules for third party modules.

    this version does not have user profile edit page.

    Source code(tar.gz)
    Source code(zip)
Owner
Quokka Project
Quokka - The happiest CMS in the world
Quokka Project
A Django content management system focused on flexibility and user experience

Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience,

Wagtail 13.8k Jan 1, 2023
The lektor static file content management system

Lektor Lektor is a static website generator. It builds out an entire project from static files into many individual HTML pages and has a built-in admi

Lektor CMS 3.6k Dec 29, 2022
VaporCMS - The greatest content management system that will never exist

The greatest content management system that will never exist Overview WordPress is a huge success but could it be done better? Maybe being mo

Andrew Dailey 4 Jan 6, 2022
Indico - A feature-rich event management system, made @ CERN, the place where the Web was born.

Indico Indico is: ? a general-purpose event management tool; ? fully web-based; ? feature-rich but also extensible through the use of plugins; ⚖️ O

Indico 1.4k Dec 31, 2022
Library Management system designed for managing and operating various aspects of a library

Proposal This proposal is written to clarify the project work of Information Systems, assigned to us as an individual task in order to tackle the case

Prawal 1 Oct 27, 2021
CSM: Construction Safety Management system

CSM: Construction Safety Management system 1. 서비스 소개 개요: 공사현장에서의 최적의 안전진단기술을 통한 고도화된 시스템으로 개선하고자 함 목표: 안전 관련 주요 시각데이터를 Cross-Domain으로 활용하여 통합 안전 관리기술의

null 5 Jul 29, 2022
A full stack e-learning application, this is the backend using django restframework and docker.

DevsPrime API API Service backing client interfaces Technologies Python 3.9 : Base programming language for development Bash Scripting : Create conven

Nnabue Favour Chukwuemeka 1 Oct 21, 2021
A course management web application

umber a course management web app built with python Flask, sqlite3, and git. installation Tested on Ubuntu 18 with python 3.5. # -- Install the system

Jim Mahoney 6 Jun 3, 2022
wger Workout Manager is a free, open source web application that helps you manage your personal workouts, weight and diet plans and can also be used as a simple gym management utility.

wger (ˈvɛɡɐ) Workout Manager is a free, open source web application that helps you manage your personal workouts, weight and diet plans and can also be used as a simple gym management utility.

wger Project 2k Dec 29, 2022
Student-Management-System-in-Python - Student Management System in Python

Student-Management-System-in-Python Student Management System in Python

G.Niruthian 3 Jan 1, 2022
A script that will warn you, by opening a new browser tab, when there are new content in your favourite websites.

web check A script that will warn you, by opening a new browser tab, when there are new content in your favourite websites. What it does The script wi

Jaime Álvarez 52 Mar 15, 2022
Simple Login - Login Extension for Flask - maintainer @cuducos

Login Extension for Flask The simplest way to add login to flask! Top Contributors Add yourself, send a PR! How it works First install it from PyPI. p

Flask Extensions 181 Jan 1, 2023
(Now finding maintainer) 🐍A Pythonic way to provide JWT authentication for Flask-GraphQL

Flask-GraphQL-Auth What is Flask-GraphQL-Auth? Flask-GraphQL-Auth is JWT decorator for flask-graphql inspired from Flask-JWT-Extended. all you have to

Seonghyeon Kim 64 Feb 19, 2022
Simple Login - Login Extension for Flask - maintainer @cuducos

Login Extension for Flask The simplest way to add login to flask! Top Contributors Add yourself, send a PR! How it works First install it from PyPI. p

Flask Extensions 132 Feb 10, 2021
Simple Login - Login Extension for Flask - maintainer @cuducos

Login Extension for Flask The simplest way to add login to flask! How it works First, install it from PyPI: $ pip install flask_simplelogin Then, use

Flask Extensions 181 Jan 1, 2023
Kotti is a high-level, Pythonic web application framework based on Pyramid and SQLAlchemy. It includes an extensible Content Management System called the Kotti CMS.

Kotti Kotti is a high-level, Pythonic web application framework based on Pyramid and SQLAlchemy. It includes an extensible Content Management System c

Kotti 394 Jan 7, 2023
The lektor static file content management system

Lektor Lektor is a static website generator. It builds out an entire project from static files into many individual HTML pages and has a built-in admi

Lektor CMS 3.6k Dec 29, 2022