Package: pyinstaller-versionfile
pyinstaller-versionfileCreate a windows version-file from a simple YAML file that can be used by PyInstaller.BackgroundPyinstaller provides a way tocapture Windows version datathrough a so calledversion-file. The process of crafting such a version file, and especially keeping the version number
updated, is a bit cumbersome.
This package aims to make the creation of such a version file easier.The key/value pairs that be specified in the version file andtheir official meaningare shown the following table:Parameter NameDescriptionCompanyNameName of the company that produced the file, for example, "My Imaginary Company, Inc.".FileDescriptionDescription to be presented to users. It may be displayed when the user is choosing files to install. For example, "A simple app that does simple things.".InternalNameInternal name of the file. If the file has no internal name, this string should be the original filename, without extension. For example, 'Simple App".LegalCopyrightCopyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. For example, "Copyright © 2000-2022, My Imaginary Company, Inc. All rights reserved.".OriginalFilenameOriginal name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. For example, "SimpleApp.exe".ProductNameName of the product with which the file is distributed, for example, "Simple App".TranslationCombinations of language and character sets supported by the application. Seethe documentationfor the codes to use. Multiple values can be specified.Usagepyinstaller-versionfile provides both a command line interface and a functional API.Command line interfacepyinstaller-versionfile provides a command line interface to convert a simple YAML file into a version-file suitable
to pass to PyInstaller via the--version-file=option.A complete YAML configuration looks like this:Version:1.2.3.4CompanyName:My Imaginary CompanyFileDescription:Simple AppInternalName:Simple AppLegalCopyright:© My Imaginary Company. All rights reserved.OriginalFilename:SimpleApp.exeProductName:Simple AppTranslation:-langID:0charsetID:1200-langID:1033charsetID:1252The encoding must be UTF-8. All fields are optional, you can choose to specify only those that are of interest to you.To create version-file from this, simple run:create-version-file metadata.yml --outfile file_version_info.txtwhere metadata.yml is the YAML configuration file from above.Extracting Version InformationAs an alternative to specifying the version directly in the YAML file, there are two alternatives which may be more
suitable, depending on the use case:Link to an External FileInstead of writing the version string directly into the YAML file, you can also specify the (relative) path to another
file. Note that this file must only contain the version string and nothing else.Version:VERSION.txtCompanyName:My Imaginary CompanyFileDescription:Simple AppInternalName:Simple AppLegalCopyright:© My Imaginary Company. All rights reserved.OriginalFilename:SimpleApp.exeProductName:Simple AppSetting the Version from the Command LineIt is also possible to set the version directly over the command line using the--versionoption:create-version-file metadata.yml --outfile file_version_info.txt --version 0.8.1.5This can be useful if you want to use a CI build number as the version.Functional APIYou can also use pyinstaller-versionfile from your own python code by directly calling the functional API.importpyinstaller_versionfilepyinstaller_versionfile.create_versionfile_from_input_file(output_file="versionfile.txt",input_file="metadata.yml",version="1.2.3.4"# optional, can be set to overwrite version information (equivalent to --version when using the CLI))It is not necessary to use a file as input, you can also directly specify the desired values.
All of them are optional and will be filled with placeholder values if not specified.importpyinstaller_versionfilepyinstaller_versionfile.create_versionfile(output_file="versionfile.txt",version="1.2.3.4",company_name="My Imaginary Company",file_description="Simple App",internal_name="Simple App",legal_copyright="© My Imaginary Company. All rights reserved.",original_filename="SimpleApp.exe",product_name="Simple App",translations=[0,1200])ContributingIf you think you found a bug, or have a proposal for an enhancement, do not hesitate
to create a new issue or submit a pull request. I will look into it as soon
as possible.Changelogv2.1.1 (2022-11-21)FixAdd newtranslationsparameter to functional API. [DudeNr33]v2.1.0 (2022-11-20)NewAdd support forTranslationfield to specify supported languages and charsets. [DudeNr33]Added a table with the official definition of the parameters in the Readme. [mkhoshbin1]v2.0.0 (2021-04-06)NewFunctional API for programmatic use. [DudeNr33]Drop compatibility with Python<3.6. [DudeNr33]Definition of metadata and creation of version file are now handled in separate classes, and it is not strictly necessary to use a file as input. [DudeNr33]Use gitchangelog for automatic changelog generation. [dudenr33]