Socket
Socket
Sign inDemoInstall

quokka

Package Overview
Dependencies
20
Maintainers
1
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

quokka

Content Management Framework for Python

    0.4.0

Maintainers
1

Readme

Quokka
======

.. figure:: https://github.com/rochacbruno/quokka/raw/master/docs/emoji_small.png
   :alt: quokka

   quokka

The Happiest CMF 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 <pelican-themes.org>`__
-  Flat file NoSQL database **TinyDB** or optionally **MongoDB** for
   scale deployments
-  Host the Quokka server or generate a static website
-  Extensible via modules/plugins
-  Powered by Python, Flask, Flask-Admin, TinyMongo and Pelican Themes

Quick Start
-----------

Install and run for development mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

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

Or install quokka from PyPI
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    python3 -m venv venv
    . venv/bin/activate
    pip3 install quokka

    NOTE: QuokkaCMS requires Python 3.6+

Start a project
~~~~~~~~~~~~~~~

.. code:: bash


    $ quokka init NewWebsite --theme=flex --modules=gitpages,heroku
    ...

.. code:: bash

    🐹 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:

.. code:: bash

    .
    ├── 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 <https://github.com/grupydf/malt>`__)

.. code:: bash

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

Install modules

.. code:: bash

    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

.. code:: bash

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

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

Run your website
~~~~~~~~~~~~~~~~

.. code:: bash

    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.

.. code:: bash

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

An example of ``supervisord`` config

.. code:: ini

    [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 <http://docs.gunicorn.org/en/stable/index.html>`__

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.

.. code:: bash

    $ 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

.. code:: bash

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

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

Deploying via SCP
~~~~~~~~~~~~~~~~~

.. code:: bash

    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

.. code:: bash

    quokka publish --static --heroku --options

Deploying via FTP
~~~~~~~~~~~~~~~~~

.. code:: bash

    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

.. code:: bash

    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:

.. code:: yaml

    quokka:
      DB:
        system: tinydb
        folder: databases

to:

.. code:: yaml

    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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    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 </CONTRIBUTING.md>`__

Setup a contributor environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ensure you have ``Python3.6+`` clone this repo and:

.. code:: bash

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

    # create a Python3.6 virtual env
    make create_env

    # activate the venv
    . venv/bin/activate

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

    # run quokka
    make devserver

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

ROADMAP
-------

This list is available on
https://github.com/rochacbruno/quokka\_ng/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



Keywords

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc