Skip to content
Application Framework for Python
Python C PowerShell Shell Makefile Dockerfile Other
Branch: master
Clone or download

Latest commit


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Github Markdown Jan 17, 2018
cement Fixes #544 May 18, 2019
docker Prepare for 3.0.4 Release May 18, 2019
docs/source Bump Year to 2019 May 18, 2019
scripts Improve Windows Testing Aug 21, 2018
tests Bumping Development Version to 3.0.5 May 18, 2019
.coveragerc Cement CLI May 8, 2018
.dockerignore Improve Vagrant Setup - Resolves Issue #483 Feb 2, 2018
.gitignore Merge branch 'portland' of into portland Jun 23, 2018
.pylintrc Pylint fixes. Part of Issue #132 Sep 7, 2012
.travis.yml Fix Travis Python 3.7 Build - Pass 2 Oct 30, 2018 Update Changelog for 3.0.5 May 18, 2019 Fixes #544 May 18, 2019
Dockerfile Cleanup Project Template Jul 29, 2018
LICENSE Bump Year to 2019 May 18, 2019 Minimalize Project Template Jul 27, 2018
Makefile Add Docker Build to Makefile Nov 6, 2018 Add code quality badges Dec 3, 2018
Vagrantfile Up CPU/Memory for Vagrant Aug 21, 2018
docker-compose.yml Prepare for 3.0.4 Release May 18, 2019
lgtm.yml Create a lgtm.yml file to exclude irrelevant alerts from the analysis Dec 3, 2018
readthedocs.yml Fix RTD Jul 17, 2018
requirements-dev-windows.txt Pin minimum versions of pytest, pytest-cov, coverage for compatibility Mar 25, 2019
requirements-dev.txt Pin minimum versions of pytest, pytest-cov, coverage for compatibility Mar 25, 2019
requirements-rtd.txt Pin minimum versions of pytest, pytest-cov, coverage for compatibility Mar 25, 2019
requirements.txt Rework Docker on Alpine Apr 19, 2017
setup.cfg Change Description Nov 6, 2018

Cement Framework

Continuous Integration Status Code Quality: Python Total Alerts

Cement is an advanced Application Framework for Python, with a primary focus on Command Line Interfaces (CLI). Its goal is to introduce a standard, and feature-full platform for both simple and complex command line applications as well as support rapid development needs without sacrificing quality. Cement is flexible, and it's use cases span from the simplicity of a micro-framework to the complexity of a mega-framework. Whether it's a single file script, or a multi-tier application, Cement is the foundation you've been looking for.

The first commit to Git was on Dec 4, 2009. Since then, the framework has seen several iterations in design, and has continued to grow and improve since it's inception. Cement is the most stable, and complete framework for command line and backend application development.

Core Features

Cement core features include (but are not limited to):

  • Core pieces of the framework are customizable via handlers/interfaces
  • Handler system connects implementation classes with Interfaces
  • Extension handler interface to easily extend framework functionality
  • Config handler supports parsing multiple config files into one config
  • Argument handler parses command line arguments and merges with config
  • Log handler supports console and file logging
  • Plugin handler provides an interface to easily extend your application
  • Output handler interface renders return dictionaries to console
  • Cache handler interface adds caching support for improved performance
  • Controller handler supports sub-commands, and nested controllers
  • Hook support adds a bit of magic to apps and also ties into framework
  • Zero external dependencies* (not including optional extensions)
  • 100% test coverage (pytest)
  • 100% PEP8 compliant (flake8)
  • Extensive API Reference (sphinx)
  • Tested on Python 3.5+
  • Does not support Python 2.x

Some optional extensions that are shipped with the mainline Cement sources do require external dependencies. It is the responsibility of the application developer to include these dependencies along with their application, as Cement explicitly does not include them.

More Information


The Cement CLI Application Framework is Open Source and is distributed under the BSD License (three clause). Please see the LICENSE file included with this software.



This project includes a docker-compose configuration that sets up all required services, and dependencies for development. This is the recommended path for local development, and is the only fully supported option.

The following creates all required docker containers, and launches an ASH shell within the cement dev container for development.

$ make dev

|> cement <| src #

The above is the equivalent of running:

$ docker-compose up -d

$ docker-compose exec cement /bin/ash


An traditional VirtualENV helper is available:

$ make virtualenv

$ source env/bin/activate

|> cement <| $


An alternative option is included to run Vagrant for development. This is partially supported, primarily for the purpose of developing/testing on Windows as well as testing specific issues on target operating systems.

To see a list of configured systems:

$ vagrant status


$ vagrant up linux

$ vagrant ssh linux

vagrant@linux $ cd /vagrant

vagrant@linux $ bash scripts/vagrant/

vagrant@linux $ make virtualenv

vagrant@linux $ source env/bin/activate

|> cement >| $


Windows development and support is not 100% complete. Cement is known to run and work on Windows, however it is not a primary target for development and as such the setup is not as streamlined and currently has several known errors.

The following assumes you're running these two initial commands from a unix based system:

$ make clean

$ vagrant up windows

RDP or Login to Desktop/Console, and open a PowerShell terminal:

C:\> cd C:\Vagrant

C:\Vagrant> powershell.exe scripts\vagrant\bootstrap.ps1

C:\Vagrant> make virtualenv-windows

C:\Vagrant> .\env-windows\Scripts\activate.ps1

C:\Vagrant> make test-core

Note that only the core library is fully tested on Windows.

Running Tests and Compliance

Cement has a strict policy that all code and tests meet PEP8 guidelines, therefore flake8 is called before any unit tests run. All code submissions require 100% test coverage and PEP8 compliance:

Execute the following to run all compliance and unit tests:

$ make test

See Makefile for all other common development actions.

You can’t perform that action at this time.