setup.py - Package and install the CodeChat Server

Builds and installs CodeChat.

Contents

Release procedure

For development:

1pip install -e .[test]

Packaging script

PyPA copied code

From PyPA’s sample setup.py, read long_description from a file. This code was last updated on 15-Jun-2020 based on this commit.

Always prefer setuptools over distutils

from setuptools import setup, find_namespace_packages, find_packages
from os import path

here = path.abspath(path.dirname(__file__))

Get the long description from the README file

with open(path.join(here, "README.rst"), encoding="utf-8") as f:
    long_description = f.read()

This code was copied from version parse code then lightly modified. See version in the call to setup below.

def read(rel_path):
    with open(path.join(here, rel_path), "r", encoding="utf-8") as fp:
        return fp.read()


def get_version(rel_path):
    for line in read(rel_path).splitlines():
        if line.startswith("__version__"):
            delim = '"' if '"' in line else "'"
            return line.split(delim)[1]
    else:
        raise RuntimeError("Unable to find version string.")

My code

setup(

This must comply with PEP 0426’s name requirements.

    name="CodeChat_Server",
    version=get_version("CodeChat_Server/__init__.py"),
    description="The CodeChat Server for software documentation",
    long_description=long_description,

The project’s main homepage.

    url="http://codechat.readthedocs.io/en/latest/",
    author="Bryan A. Jones",
    author_email="bjones@ece.msstate.edu",
    license="GPLv3+",

These are taken from the full list.

    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
        "Operating System :: OS Independent",
        "Natural Language :: English",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Topic :: Software Development :: Documentation",
        "Topic :: Text Processing :: Markup",
    ],
    keywords="literate programming",

See Subdirectory for Data Files. This avoid the needs to add an __init__.py to every subdirectory containing data files I want included in the package.

Include the Python code.

    packages=find_packages() +

Include the data files needed by the code.

    find_namespace_packages(
        include=("CodeChat_Server.*",),
        exclude=(
            "CodeChat_Server.templates.doxygen._build",
            "CodeChat_Server.templates.doxygen._build.*",
            "CodeChat_Server.templates.javadoc._build",
            "CodeChat_Server.templates.javadoc._build.*",
            "CodeChat_Server.templates.mdbook.book",
            "CodeChat_Server.templates.mdbook.book.*",

Problem: these still don’t get ignored; I have to delete them manually. The same is true for other __pycache__ instances in this list.

            "CodeChat_Server.templates.mdbook.src.__pycache__",
            "CodeChat_Server.templates.mdbook.src.__pycache__.*",
            "CodeChat_Server.templates.mkdocs.site",
            "CodeChat_Server.templates.mkdocs.site.*",
            "CodeChat_Server.templates.pretext.output",
            "CodeChat_Server.templates.pretext.output.*",
            "CodeChat_Server.templates.pretext.generated-assets",
            "CodeChat_Server.templates.pretext.generated-assets.*",
            "CodeChat_Server.templates.runestone.__pycache__",
            "CodeChat_Server.templates.runestone.__pycache__.*",
            "CodeChat_Server.templates.runestone.build",
            "CodeChat_Server.templates.runestone.build.*",
            "CodeChat_Server.templates.sphinx._build",
            "CodeChat_Server.templates.sphinx._build.*",
            "CodeChat_Server.templates.sphinx.__pycache__",
            "CodeChat_Server.templates.sphinx.__pycache__.*",
        ),
    ),

List run-time dependencies here. These will be installed by pip when your project is installed. For an analysis of “install_requires” vs pip’s requirements files see: https://packaging.python.org/en/latest/requirements.html

    install_requires=(
        [
            "bottle",
            "CodeChat",
            "json-five",
            "markdown",
            "psutil",
            "strictyaml",
            "thrift",
            "typer[all]",
            "watchdog",
            "websockets",
        ]
    ),

List additional groups of dependencies here (e.g. development dependencies). You can install these using the following syntax, for example:

$ pip install -e .[test]

    extras_require={
        "test": [
            "black",
            "coverage",
            "flake8",
            "myst-parser",
            "mypy",
            "pytest",
            "requests",
            "sphinx",
        ],
    },

To package data files, I’m using include_package_data=True. See including data files.

    include_package_data=True,

Python version support: the program uses asyncio.run, which was introduced in Python 3.7.

    python_requires=">=3.7",

Make it easy to run the server.

    entry_points={
        "console_scripts": ["CodeChat_Server = CodeChat_Server.__main__:app"]
    },
)