Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.43 KB

DEVELOPMENT.rst

File metadata and controls

47 lines (30 loc) · 1.43 KB

Development Guide

Requirements

In addition to Python 3 and normal development tools, ie, the build-essentials package on Ubuntu, XCode on OS X, etc, you also need to install pre-commit.

Installing for development

Unoserver uses a Makefile as a shortcut for common development tasks. To install Unoserver for development, simply clone the repository, and then make the development environment.

You need to make the virtualenvironment with --system-site-packages to get access to the uno library. (This assumes you have a LibreOffice installation that uses the system Python).

$ git clone [email protected]:unoconv/unoserver.git $ cd unoserver $ virtualenv ve --system-site-packages $ ve/bin/pip install -e .[devenv]

Code quality

This package uses github actions to run code quality checks and tests. We use flake8 for quality, black for styling and pyroma for packaging tests. To ensure that your pull requests doesn't fail on those tests, you can install the pre-commit-hooks package. See https://pre-commit.com/ .

Running tests

$ make test

Releasing

For releases we use zest.releaser to release, package and upload to PyPI. Make sure you have a correct .pypirc so that you can upload packages to PyPI. The run the fullrelease command from zest.releaser, and it will guide you through the process.

$ fullrelease