Metadata-Version: 1.1
Name: quokka
Version: 0.4.1.dev6
Summary: Content Management Framework for Python
Home-page: https://github.com/rochacbruno/quokka
Author: Bruno Rocha
Author-email: rochacbruno@gmail.com
License: BSD License
Description: 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 (some to be implemented)
        ---------------------------------
        
        -  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 on **server** or generate a **static** website
        -  Extensible via modules/plugins
        -  Powered by Python, Flask, Flask-Admin, TinyMongo and Pelican Themes
        
        Quick Start
        -----------
        
            NOTE: QuokkaCMS requires Python 3.6+
        
        Install and run for development mode
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
            this is the recommended way while 1.0.0 is not released
        
        .. code:: bash
        
            git clone https://github.com/rochacbruno/quokka
            cd quokka
            python3 -m venv venv
            . venv/bin/activate
            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 hacking the code!
        
        Or install quokka from PyPI
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
            May not be stable until 1.0.0 is released
        
        .. code:: bash
        
            python3 -m venv venv
            . venv/bin/activate
            pip3 install quokka
        
        and 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 can to edit ``quokka.yml`` to tune your
            settings.
        
        Create an admin user
        ^^^^^^^^^^^^^^^^^^^^
        
        ::
        
            quokka adduser
        
        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+`` fork this repo and:
        
        .. code:: bash
        
            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
        ~~~~~~~~~~~~~~~~~~~
        
        .. figure:: https://user-images.githubusercontent.com/458654/35923897-a6f321be-0c08-11e8-95ff-5510862326ea.png
           :alt: home cms
        
           home cms
        
        Pelican themes compatible
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        An article showing in Malt theme
        
        .. figure:: https://user-images.githubusercontent.com/458654/35923881-a128c9d2-0c08-11e8-94b4-813588209f04.png
           :alt: start contributing to quokka project my site
        
           start contributing to quokka project my site
        
        The same article using Bootstrap 3 theme
        
        .. figure:: https://user-images.githubusercontent.com/458654/35924086-32840ebe-0c09-11e8-861e-db1a66b87326.png
           :alt: start contributing to quokka project my site2
        
           start contributing to quokka project my site2
        
            See more on screenshots on
            https://github.com/rochacbruno/quokka/issues/647
        
        Start contributing right now!
        =============================
        
        
Keywords: cms content management flask static site blog
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
