# -*- coding: utf-8; mode: python; mode: flycheck -*-
# SPDX-License-Identifier: AGPL-3.0-or-later
# pylint: disable=line-too-long, invalid-name, consider-using-f-string
"""Python package meta informations used by setup.py and other project files.
Single point of source for all xxxx package metadata. After modifying this
file it is needed to recreate some projet files::
./local/py3/bin/python -c "from xxxx.__pkginfo__ import *; print(README)" > README.rst
./local/py3/bin/python -c "from xxxx.__pkginfo__ import *; print(requirements_txt)" > requirements.txt
About python packaging see `Packaging Python Projects`_ and `Python Packaging
Authority`_. Most of the names here are mapped to ``setup(<name1>=...,
<name2>=...)`` arguments in ``setup.py``. See `Packaging and distributing
projects`_ about ``setup(...)`` arguments. If this is all new for you, start
with `PyPI Quick and Dirty`_.
Further read:
- pythonwheels_
- setuptools_
- packaging_
- sdist_
- installing_
.. _`Python Packaging Authority`: https://www.pypa.io
.. _Packaging Python Projects: https://packaging.python.org/en/latest/tutorials/packaging-projects/
.. _`Packaging and distributing projects`: https://packaging.python.org/guides/distributing-packages-using-setuptools/
.. _`PyPI Quick and Dirty`: https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
.. _pythonwheels: https://pythonwheels.com/
.. _setuptools: https://setuptools.readthedocs.io/en/latest/setuptools.html
.. _packaging: https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-and-distributing-projects
.. _sdist: https://packaging.python.org/guides/distributing-packages-using-setuptools/#source-distributions
.. _bdist_wheel: https://packaging.python.org/guides/distributing-packages-using-setuptools/#pure-python-wheels
.. _installing: https://packaging.python.org/tutorials/installing-packages/
"""
# pylint: enable=line-too-long
from setuptools import find_packages
package = 'boilerplate'
version = '20230630'
copyright = '2023 Markus Heiser'
description = 'xxxx lorem ipsum'
license = 'AGPLv3+' # pylint: disable=redefined-builtin
keywords = 'boilerplate template'
author = 'Markus Heiser'
author_email = 'markus.heiser@darmarIT.de'
authors = [author, ]
emails = [author_email, ]
maintainer = 'Markus Heiser'
maintainer_email = 'markus.heiser@darmarIT.de'
maintainers = [maintainer, ]
url = 'https://github.com/return42/boilerplate'
docs = 'https://return42.github.io/boilerplate'
issues = url + '/issues'
project_urls = {
'Documentation' : docs,
'Code' : url,
'Issue tracker' : issues,
'Changelog' : url + '/blob/master/CHANGELOG',
}
packages = find_packages(exclude=['docs', 'tests'])
# https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files
package_data = {
# 'xxxx' : [
# 'config.ini',
# 'log.ini',
# 'mime.types',
# ]
}
# https://docs.python.org/distutils/setupscript.html#installing-additional-files
# https://setuptools.readthedocs.io/en/latest/setuptools.html?highlight=options.data_files#configuring-setup-using-setup-cfg-files
# https://www.scivision.dev/newer-setuptools-needed/
# https://setuptools.readthedocs.io/en/latest/history.html#v40-5-0
data_files = [
# ('/etc/xxxx', [
# 'xxxx/config.ini',
# 'xxxx/log.ini',
# ])
# , ('/usr/share/doc/xxxx', [
# 'README.rst',
# 'LICENSE.txt',
# ])
]
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
python_requires ='>=3.8'
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#py-modules
py_modules = []
# Since pip v18.1 [PEP508-URL] is supported!
#
# Don't use depricated [dependency_links] any more. See [git+] for using repos
# as packages. E.g. 'xxxx's master from github with *all extras* is added to
# the requirements by::
#
# xxxx @ git+https://github.com/return42/xxxx[devel,test]
#
# The setup.py 'extra_requires' addressed with [PEP-508 extras], here in the
# example 'devel' and 'test' requirements also installed.
#
# [PEP-508 URL] https://www.python.org/dev/peps/pep-0508/
# [PEP-508 extras] https://www.python.org/dev/peps/pep-0508/#extras
# [git+] https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support
# [requirements.txt] https://pip.pypa.io/en/stable/user_guide/#requirements-files
# [dependency_links] https://python-packaging.readthedocs.io/en/latest/dependencies.html
install_requires = [
'fspath',
'setuptools',
# 'wheel',
]
install_requires.sort()
install_requires_txt = "\n".join(install_requires)
test_requires = [
'pylint'
]
test_requires.sort()
test_requires_txt = "\n".join(test_requires)
develop_requires = [
'docutils',
'linuxdoc @ git+http://github.com/return42/linuxdoc.git',
'pallets-sphinx-themes',
'sphinx',
'sphinx-autobuild',
'sphinx-issues',
'sphinx-jinja',
'sphinx-tabs',
'sphinxcontrib-programoutput',
'sphinxjp.themes.revealjs @ git+https://github.com/return42/sphinxjp.themes.revealjs',
'tox',
'twine',
]
develop_requires_txt = "\n".join(develop_requires)
[docs]def get_entry_points():
"""get entry points of the python package"""
return {
'console_scripts': [
'xxxx = xxxx.cli:main' # Main xxxx_ console script
]}
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Other Audience",
"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Utilities",
"Topic :: Software Development :: Libraries :: Application Frameworks",
"Topic :: Software Development :: Libraries :: Python Modules",
]
docstring = """\
.. sidebar:: Info
- %(package)s (%(version)s)
- %(copyright)s / %(license)s
- %(url)s
Nothing special here, only some of my boilerplates
Documentation is available at ./docs or jump to:
%(docs)s
""" % globals()
# docstring = """
# .. sidebar:: Info
#
# - %(package)s (%(version)s)
# - %(copyright)s / %(license)s
# - %(url)s
#
# The python `xxxx <%(docs)s>`__ package helps .. . It comes with an API and the
# xxxx command line (see `use <%(docs)s/use.html>`__).
#
# Install
# =======
#
# Install and update using `pip <https://pip.pypa.io/en/stable/quickstart/>`__:
#
# .. code:: bash
#
# pip install -U %(package)s
# """ % globals()
README = """\
===========
%(package)s
===========
%(docstring)s
Install
=======
To install use `pip <https://pip.pypa.io/en/stable/getting-started/>`__:
.. code-block:: text
pip install --user -U %(package)s
Links
=====
- Documentation: %(docs)s
- Releases: https://pypi.org/project/linuxdoc/
- Code: %(url)s
- Issue tracker: %(url)s/issues
============ ===============================================
package: %(package)s (%(version)s)
copyright: %(copyright)s
e-mail: %(maintainer_email)s
license: %(license)s
============ ===============================================
""" % globals()
requirements_txt = """\
%(install_requires_txt)s
""" % globals()
requirements_dev_txt = """\
%(test_requires_txt)s
%(develop_requires_txt)s
""" % globals()
