initial commit

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Build
+
+on:
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions poetry
+    - name: Test with tox
+      run: tox

.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+pip-wheel-metadata/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+/.idea
+
+.vim
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+.envrc
+*.csv
+*.pdf

.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+build:
+  image: latest
+
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

CHANGELOG.rst

@@ -0,0 +1,12 @@
+Changelog
+=========
+
+0.1.0 (2022-??-??)
+------------------
+
+- First usable version
+
+0.0.1 (2022-10-28)
+------------------
+
+- Initial release

Makefile

@@ -0,0 +1,43 @@
+.PHONY: clean isort isort-check format format-check fix lint type-check pytest check test documentation docs
+
+
+
+init:
+	poetry install
+	pip install -r docs/requirements.txt
+
+clean:
+	rm -rf .coverage .hypothesis .mypy_cache .pytest_cache .tox *.egg-info
+	rm -rf dist
+	find . | grep -E "(__pycache__|docs_.*$$|\.pyc|\.pyo$$)" | xargs rm -rf
+
+isort:
+	isort .
+
+isort-check:
+	isort . --check-only --diff
+
+format:
+	black .
+
+format-check:
+	black --check --diff .
+
+fix: isort format
+
+lint:
+	flake8 --exclude=.tox,build
+
+type-check:
+	mypy --pretty src tests
+
+check: lint isort-check format-check type-check
+
+pytest:
+	pytest --cov=pdfje
+
+test: check pytest
+
+docs:
+	@touch docs/api.rst
+	make -C docs/ html

README.rst

@@ -0,0 +1,51 @@
+🖍 PDFje
+========
+
+.. image:: https://img.shields.io/pypi/v/pdfje.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/pdfje
+
+.. image:: https://img.shields.io/pypi/l/pdfje.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/pdfje
+
+.. image:: https://img.shields.io/pypi/pyversions/pdfje.svg?style=flat-square
+   :target: https://pypi.python.org/pypi/pdfje
+
+.. image:: https://img.shields.io/readthedocs/pdfje.svg?style=flat-square
+   :target: http://pdfje.readthedocs.io/
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square
+   :target: https://github.com/psf/black
+
+-----
+
+  **PDF·je** *(noun)* Dutch for "small PDF"
+
+Tiny library for writing simple PDFs. Experimental.
+
+Currently under development.
+Leave a ⭐️ on GitHub if you're interested how this develops!
+
+Why?
+----
+
+The most popular libraries for writing PDFs are quite old and inspired by Java and PHP.
+This library is an attempt to create a modern Pythonic library with a more declarative API.
+
+.. How does it work?
+.. -----------------
+
+.. .. code-block:: python
+
+..   >>> import pdfje as pdf
+..   >>> pdf.Document().write('hello.pdf')
+
+.. See `the docs <https://pdfje.rtfd.io>`_ for a complete overview.
+
+Installation
+------------
+
+It's available on PyPI.
+
+.. code-block:: bash
+
+  pip install pdfje

dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: tox
+    versions:
+    - "< 3.6, >= 3.5.a"

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Quiz
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.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
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,7 @@
+API reference
+=============
+
+.. automodule:: pdfje
+   :members:
+   :exclude-members: __namedtuple_cls__, __hash__, __weakref__, __getnewargs__,
+      __new__, __repr__, __eq__, __ne__, __init__, __next_in_mro__

docs/conf.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 13 22:58:12 2017.
+#
+# 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.
+
+# -- Project information -----------------------------------------------------
+import importlib.metadata
+
+metadata = importlib.metadata.metadata("pdfje")
+
+project = metadata["Name"]
+author = metadata["Author"]
+version = metadata["Version"]
+release = metadata["Version"]
+
+
+# -- General configuration ------------------------------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+templates_path = ["_templates"]
+source_suffix = ".rst"
+
+master_doc = "index"
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output ----------------------------------------------
+
+autodoc_member_order = "bysource"
+html_theme = "furo"
+highlight_language = "python3"
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}