The pywriter package is not intended to be installed by the user, e.g. via pip. Instead, applications based on PyWriter shall be self contained. That means, they contain all the code in a single script.
An application is built using the inliner.py script, which copies the code of all modules imported from the pywriter package. The inliner script is called from an application-specific build script that passes the project-specific paths as parameters.
This is the directory structure required for building an application:
.
├── PyWriter/
│ └── src/
│ ├── pywriter/
│ └── inliner.py
└── application/
├── src/
├── test/
└── tools/
├── build.xml
└── build_application.py
IMPORTANT
As of PyWriter v12.1.2, inliner.py discards docstrings of imported modules in order to save memory.
Docstrings are considered to be all strings that begin and end with three double quotes.
Thus, multiline strings not to be discarded during building must start and end with three single quotes.
- The code must be compatible with Python version 3.6.
- The Python source code formatting follows widely the PEP 8 style guide, except the maximum line length, which is 120 characters here.
- The code commenting follows the PEP 257 convention. pydoc can be used to display documentation for the pywriter modules and classes.
- Instead of inserting inline comments, append block comments.
- Type hints are not used.
- Strings are preferably enclosed in single quotes. Double quotes should only be used if nesting with single quotes is unavoidable.
- Strings should not be concatenated with the
+operator, but with f-strings. See PEP 498. - All strings that appear on the user interface must be prepared for translation with GNU gettext, like:
_('See this message.'). - A package's init.py must not contain executable code.
- Each PyWriter class is implemented in its own module.
- PyWriter classes are imported with
from <module> import <class>.