global_constants

String constants used throughout the TurboCtl project.

This module defines a place where string constants such as URLs can be defined and changed without having to go through multiple files to manually change the values in each of them.

In addition to the turboctl Python module, these constants are used by the Sphinx documentation and scripts at the top level of the project.

turboctl.global_constants.TESTPYPI_URL = 'https://test.pypi.org/project/turboctl/'

The URL of the TurboCtl project on TestPyPI.

turboctl.global_constants.PYPI_URL = 'https://pypi.org/project/turboctl/'

The URL of the TurboCtl project on PyPI.

turboctl.global_constants.GITHUB_URL = 'https://github.com/fkivela/TurboCtl'

The URL of the TurboCtl repository on GitHub.

turboctl.global_constants.DOCS_URL = 'https://turboctl.readthedocs.io/en/latest/index.html'

The URL of TurboCtl documentation on Read the Docs.

turboctl.global_constants.AUTHOR = 'Feliks Kivelä'

The author of the TurboCtl project.

turboctl.global_constants.EMAIL = 'firstname.lastname@aalto.fi'

The email of the TurboCtl author.

This uses the firstname.lastname format in order to provide some degree of protection against email scrapers.

turboctl.global_constants.COPYRIGHT = '2019-2024 University of Helsinki Fusor Team'

Copyright information with an automatically updating year.

turboctl.global_constants.VERSION = '1.1.1'

The current version of the TurboCtl project.

turboctl.global_constants.SPHINX_PATH = 'doc/sphinx'

The path to the Sphinx documentation directory, relative to the top-level TurboCtl directory.

turboctl.global_constants.REVERSE_SPHINX_PATH = '../..'

The path to the top-level TurboCtl directory, relative to the Sphinx documentation directory.

turboctl.global_constants.main()

Write the constants defined in this module to a shell file.