Added Tutorial in Khmer language

.banditrc.yml

@@ -0,0 +1,4 @@
+skips:
+  # Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
+  # => OK, we don't care though
+  - B101

.coveragerc

@@ -0,0 +1,16 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+
+[report]
+include =
+    fpdf/*.py
+    fpdf/**/*.py
+
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if non-runnable code isn't run:
+    if __name__ == .__main__.:

.gitattributes

@@ -0,0 +1,14 @@
+# Enforce Unix newlines
+* text eol=lf
+
+# Binary files
+*.pdf binary
+*.p12 binary
+*.otf binary
+*.ttf binary
+*.TTF binary
+*.bmp binary
+*.jpg binary
+*.gif binary
+*.png binary
+*.webp binary

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug report
+about: Report some unexpected behaviour to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+<!--
+Hi there! Thank you for wanting to make fpdf2 better 😉.
+
+Please perform a quick search first, in order to check if your problem has already been reported:
+https://github.com/PyFPDF/fpdf2/issues
+-->
+
+Describe the bug
+
+**Error details**
+If an exception is raised, it is very important that you provide the full error message.
+Otherwise members of the fpdf2 community won't be able to help you with your problem.
+
+**Minimal code**
+Please include some minimal Python code reproducing your issue:
+```python
+from fpdf import FPDF
+
+pdf = FPDF()
+...
+```
+If you don't know how to build a minimal reproducible example, please check this tutorial: https://stackoverflow.com/help/minimal-reproducible-example
+
+**Environment**
+Please provide the following information:
+* **Operating System**: Windows, Mac OSX, Linux flavour...
+* **Python version**: you can get this information with `python --version`
+* **`fpdf2` version used**: if you installed it with `pip`, you can get this information in `pip freeze` output
+
+<!-- Bonus / recommended:
+
+Often, there are bugfixes & other changes on fpdf2 git repo `master` branch
+that have not been released yet. They are listed in the ChangeLog:
+https://github.com/PyFPDF/fpdf2/blob/master/CHANGELOG.md
+
+Hence, please check that your bug is still present using the latest version of fpdf2 from the git repository,
+by installing it this way:
+
+    pip install git+https://github.com/PyFPDF/fpdf2.git@master
+
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Start a discussion
+    url: https://github.com/PyFPDF/fpdf2/discussions/new
+    about: Informal discussion about the project organization, considerations that do not expect a definitive answer, etc.
+#  - name: Security issue
+#    url: security@...
+#    about: Do not report security issues publicly. Email our security contact.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+<!--
+Hi there! Thank you for wanting to make fpdf2 better 😉.
+
+Before you submit this, make sure that this feature wasn't already requested,
+or if it is not already implemented in the master branch but not released yet:
+https://github.com/PyFPDF/fpdf2/blob/master/CHANGELOG.md
+-->
+
+**Please explain your intent**
+Describe what you want to achieve.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+Please also mention any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context, code snippet or screenshots about the feature request.
+You can also mention if you are willing to contribute a PR yourself to provide this feature.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: I have a question
+about: Anything that is not a bug report or a feature request
+title: ''
+labels: question
+assignees: ''
+---
+<!--
+Hi there! Thank you for reaching out and stepping in fpdf2 users community 😉.
+
+Before submitting your question, please check:
+* that it is not covered by the documentation: https://pyfpdf.github.io/fpdf2/
+* that it has not already been asked: https://github.com/PyFPDF/fpdf2/issues
+-->

.github/pull_request_template.md

@@ -0,0 +1,41 @@
+<!--
+Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
+
+Some guidelines are provided like this, in HTML comments, to expedite the code review before merging your contribution.
+
+First, please make sure that you have read the documentation page on fpdf2 development:
+https://pyfpdf.github.io/fpdf2/Development.html
+
+If you're new to contributing to open source projects,
+you might find this free video course helpful: http://kcd.im/pull-request
+-->
+
+<!-- What changes are being made? (What feature/bug is being fixed here?) -->
+
+e.g. Fixes #0 <!-- This will automatically close issue #0 once the PR is merged: https://help.github.com/en/articles/closing-issues-using-keywords -->
+
+<!-- Have you done all of these things?  -->
+**Checklist**:
+
+<!-- To check an item, place an "x" in the box like so: "- [x] Item description"
+     Add "N/A" to the end of each line that's irrelevant to your changes -->
+
+- [ ] The GitHub pipeline is OK (green), <!-- The maintainers will trigger it if this is your 1st contribution -->
+      meaning that both `pylint` (static code analyzer) and `black` (code formatter) are happy with the changes of this PR.
+
+- [ ] A unit test is covering the code added / modified by this PR
+
+- [ ] This PR is ready to be merged <!-- In your opinion, can this be merged as soon as it's reviewed? Else, this can be turned into a Draft PR -->
+
+- [ ] In case of a new feature, docstrings have been added, with also some documentation in the `docs/` folder
+
+- [ ] A mention of the change is present in `CHANGELOG.md`
+
+<!-- Feel free to add additional comments, and to ask questions if some of those guidelines are unclear to you! -->
+
+<!--
+Once a PR is merged, maintainers will add your name to the contributors table in README.md.
+If they forget, or you do not wish this to happen, please mention it.
+-->
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the [GNU LGPL 3.0 license](https://github.com/PyFPDF/fpdf2/blob/master/LICENSE).

.github/workflows/continuous-integration-workflow.yml

@@ -0,0 +1,108 @@
+name: build
+
+on:  # cf. https://github.community/t/how-to-trigger-an-action-on-push-or-pull-request-but-not-both/16662
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        platform: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }} 🔧
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install system dependencies ⚙️
+        if: matrix.platform == 'ubuntu-latest'
+        run: sudo apt-get update && sudo apt-get install ghostscript libjpeg-dev
+      - name: Install qpdf ⚙️
+        if: matrix.platform == 'ubuntu-latest' && matrix.python-version != '3.9'
+        # We run the unit tests WITHOUT qpdf for a single parallel execution / Python version:
+        run: sudo apt-get update && sudo apt-get install qpdf
+      - name: Install Python dependencies ⚙️
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install --upgrade . -r test/requirements.txt -r docs/requirements.txt -r contributors/requirements.txt
+      - name: Statically checking code 🔎
+        if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        run: |
+          pylint fpdf test tutorial/tuto*.py
+          bandit -c .banditrc.yml -r contributors/ fpdf/ tutorial/
+          semgrep scan --config auto --lang=py --error --strict --exclude-rule=python.lang.security.insecure-hash-function.insecure-hash-function fpdf
+      - name: Ensure code has been autoformatted with black 🖌️
+        if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        run: black --check .
+      - name: Checking all PDF samples ☑
+        if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        run: |
+          # Using qpdf
+          find . -name '*.pdf' | xargs -n 1 qpdf --check --password=fpdf2
+          # Using Datalogics PDF Checker:
+          scripts/install-pdfchecker.sh
+          find . -name '*.pdf' | xargs -n 1 scripts/pdfchecker.py
+          scripts/pdfchecker.py  # printing aggregated report
+          # Using VeraPDF:
+          scripts/install-verapdf.sh
+          find . -name '*.pdf' | xargs -n 1 scripts/verapdf.py
+          scripts/verapdf.py  # printing aggregated report
+      - name: Running tests ☑
+        env:
+          CHECK_EXEC_TIME: ${{ matrix.python-version == '3.9' && 'test-enabled' || '' }}
+          CHECK_RSS_MEMORY: ${{ matrix.python-version == '3.11' && 'test-enabled' || '' }}
+        run: |
+          # Ensuring there is no `generate=True` left remaining in calls to assert_pdf_equal:
+          grep -IRF generate=True test/ && exit 1
+          # Executing all tests:
+          pytest -vv --trace-memory-usage
+      - name: Uploading coverage report to codecov.io ☑
+        if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        run: bash <(curl -s https://codecov.io/bash)
+      - name: Generating HTML documentation 🏗️
+        # As build_contributors_html_page.py can hang due to GitHub rate-limiting,
+        # we only execute this on master for now. And it should always be executed for one Python version only.
+        if: github.ref == 'refs/heads/master' && matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          mkdir -p public/
+          # Setting PDF manual version:
+          sed -i "s/author:.*/author: v$(python setup.py -V 2>/dev/null)/" mkdocs.yml
+          cp tutorial/notebook.ipynb docs/
+          mkdocs build
+          pdoc --html -o public/ fpdf --config "git_link_template='https://github.com/PyFPDF/fpdf2/blob/{commit}/{path}#L{start_line}-L{end_line}'"
+          cd contributors/ && PYTHONUNBUFFERED=1 ./build_contributors_html_page.py PyFPDF/fpdf2
+          cp -t ../public/ contributors.html contributors-map-small.png
+      - name: Deploy documentation 🚀
+        # GitHub Pages deployment should not be done for all Python versions,
+        # otherwise commits will conflict on the gh-pages branch:
+        if: github.ref == 'refs/heads/master' && matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: public/
+      - name: Publish on Pypi 🚀
+        # Similarly, we only publish a new version on Pypi once per pipeline running on master:
+        if: github.ref == 'refs/heads/master' && matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+        run: |
+          echo Versions already released on Pypi: $(curl -Ls 'https://pypi.org/pypi/fpdf2/json' | jq -r '.releases|keys[]')
+          echo Current code version: $(python setup.py -V)
+          # Checking if current code version has already been released:
+          curl -Ls 'https://pypi.org/pypi/fpdf2/json' | jq -r '.releases|keys[]' | grep "^$(python setup.py -V)\$" && exit 0
+          # No? Then performing a release on Pypi now:
+          pip install --upgrade twine wheel
+          python setup.py sdist bdist_wheel
+          twine check dist/*
+          twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.FPDF2_GITHUB_ACTION_PUBLISH }}

.gitignore

@@ -1,10 +1,34 @@
+# my files
+.env
+
+# codecov.io
+coverage.xml
+
+htmlcov
+public
+tutorial/invoice.pdf
+PDF_Checker/
+verapdf/
+pdfchecker-aggregated.json
+verapdf-aggregated.json
+
+contributors/contributors.html
+
 *.py[cod]
 
 # C extensions
 *.so
 
+# virtualenv
+include/
+local/
+
+# vscode
+.vscode
+
 # Packages
 *.egg
+.eggs
 *.egg-info
 dist
 build
@@ -20,6 +44,7 @@ lib64
 
 # Installer logs
 pip-log.txt
+pip-selfcheck.json
 
 # Unit test / coverage reports
 .coverage
@@ -33,3 +58,10 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+
+# Idea
+.idea
+
+# Vim backup and swap files
+*.*~
+*.swp

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+---
+exclude: ^(\.[^/]*cache(__)?/.*|(.*/)?\.coverage)$
+repos:
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.1
+    hooks:
+      - id: remove-crlf
+      - id: remove-tabs
+      - id: chmod
+        args: ['644']
+        exclude: (^(contributors|docs|scripts|tutorial)/.*\.py|\.sh)$
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+  - repo: local
+    hooks:
+    -   id: no-print-in-sources
+        name: Ensure no print() statement appears in fpdf2 sources
+        language: pygrep
+        entry: print\(
+        files: ^fpdf/.*\.py$
+        exclude: fpdf/util.py
+    -   id: no-generate-true
+        name: Ensure no generate=True is left in a call to assert_pdf_equal()
+        language: pygrep
+        entry: generate=True
+        files: ^test/.*\.py$
+    -   id: pylint
+        name: pylint
+        # 3x faster than the official pylint hook, and has no issue with imports
+        # (tested with: time pre-commit run pylint --all-files)
+        language: system
+        entry: pylint
+        files: ^(fpdf/|test/|tutorial/tuto).*\.py$