Commit 277f01a5 authored by Jerome Flesch's avatar Jerome Flesch

Add Makefile

Signed-off-by: Jerome Flesch's avatarJerome Flesch <>
parent 555a32f7
......@@ -5,3 +5,4 @@ dist/
VERSION_FILE = src/pyocr/
build: build_c build_py
install: install_py install_c
uninstall: uninstall_py
build_py: ${VERSION_FILE}
python3 ./ build
echo -n "version = \"" >| $@
echo -n $(shell git describe --always) >> $@
echo "\"" >> $@
version: ${VERSION_FILE}
doc: install_py
(cd doc && make html)
cp doc/index.html doc/build/index.html
pydocstyle pyinsane2
echo "Library. Can't make executable"
ifeq (${RELEASE}, )
@echo "You must specify a release version (make release RELEASE=1.2.3)"
@echo "Will release: ${RELEASE}"
@echo "Checking release is in ChangeLog ..."
grep ${RELEASE} ChangeLog
@echo "Releasing ..."
git tag -a ${RELEASE} -m ${RELEASE}
git push origin ${RELEASE}
make clean
make version
python3 ./ sdist upload
@echo "All done"
rm -rf doc/build
rm -rf build dist *.egg-info
rm -rf src/pyocr/__pycache__
install_py: ${VERSION_FILE}
python3 ./ install ${PIP_ARGS}
pip3 uninstall -y pyinsane2
@echo "make build || make build_py"
@echo "make check"
@echo "make doc"
@echo "make help: display this message"
@echo "make install || make install_py"
@echo "make release"
@echo "make test"
@echo "make uninstall || make uninstall_py"
build \
build_c \
build_py \
check \
doc \
exe \
help \
install \
install_c \
install_py \
release \
test \
uninstall \
uninstall_c \
# Minimal makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = python3 -m sphinx
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<title>PyOCR documentation</title>
<meta http-equiv="content-language" content="en">
<li><a href="sphinx/html/index.html">Python API documentation</a></li>
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# PyOCR documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 9 08:39:36 2018.
# This file is execfile()d with the current directory set to its
# containing dir.
# Note that not all possible configuration values are present in this
# autogenerated file.
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'PyOCR'
copyright = '2018,'
author = ''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'PyOCRdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
# 'figure_align': 'htbp',
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PyOCR.tex', 'PyOCR Documentation',
'', 'manual'),
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pyocr', 'PyOCR Documentation',
[author], 1)
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PyOCR', 'PyOCR Documentation',
author, 'PyOCR', 'One line description of project.',
.. PyOCR documentation master file, created by
sphinx-quickstart on Fri Feb 9 08:39:36 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyOCR's documentation!
.. toctree::
:maxdepth: 2
:caption: Contents:
Pyinsane2 Python API
.. automodule:: pyocr
Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
#!/usr/bin/env python
import sys
from setuptools import setup
with open("src/pyocr/", "r") as file_descriptor:
version =
version = version.split(" ")[2][1:-1]
print("PyOCR version: {}".format(version))
if "-" in version:
version = version.split("-")[0]
except FileNotFoundError:
print("ERROR: file is missing")
print("ERROR: Please run 'make version' first")
# Don't forget to update
# - src/pyocr/
# -
# -
# - ChangeLog
# - push
# - tag
# - python3 ./ sdist upload
description=("A Python wrapper for OCR engines (Tesseract, Cuneiform,"
" etc)"),
keywords="tesseract cuneiform ocr",
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment