Development

Elasticsearch Kibana CLI #

Development #

The following development tools are used to help create and manage this project.

shut #

shut is a Python package management and release tool - documentation link

# Update package files
$ shut pkg update

# Test the package
$ shut pkg test

# Create a staged changelog entry for a fix/feature
$ shut changelog --add fix --stage --message "Fixes bug"
$ shut changelog --add feature --stage --message "Initial version"

# Release bumps at patch/minor/major levels with --dry runs
$ shut pkg bump --patch --tag --push --dry
$ shut pkg bump --minor --tag --push --dry
$ shut pkg bump --major --tag --push --dry

# Build a package
$ shut pkg build -vvv setuptools:wheel
$ shut pkg build -vvv setuptools:*

# Publish a package
$ shut pkg publish --test warehouse:pypi
$ shut pkg publish warehouse:pypi

pydoc-markdown #

pydoc-markdown is a documentation generation tool that works well with Python modules - documentation link

# Render documentation
$ pydoc-markdown docs/pydoc-markdown.yml 

# Provide a local live review server 
$ pydoc-markdown --server docs/pydoc-markdown.yml