Your new end-to-end project management system.
# Copyright (c) 2023-present, Parafoxia, Jonxslays
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright notice, this
#        list of conditions and the following disclaimer.
#
#     2. Redistributions in binary form must reproduce the above copyright notice,
#        this list of conditions and the following disclaimer in the documentation
#        and/or other materials provided with the distribution.
#
#     3. Neither the name of the copyright holder nor the names of its
#        contributors may be used to endorse or promote products derived from
#        this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from __future__ import annotations

import typing as t
from functools import wraps
from pathlib import Path

import nox

REPO_DIR = Path(__file__).parent
PROJECT_NAME = REPO_DIR.stem
PROJECT_DIR = REPO_DIR / PROJECT_NAME
TEST_DIR = REPO_DIR / "tests"
NOX_FILE = REPO_DIR / "noxfile.py"
SETUP_FILE = REPO_DIR / "setup.py"
REQUIREMENTS_FILE = REPO_DIR / "requirements/nox.txt"

SessFT = t.Callable[[nox.Session], None]


def install(
    *, meta: bool = False, rfiles: list[str] | None = None
) -> t.Callable[[SessFT], SessFT]:
    def decorator(func: SessFT) -> SessFT:
        @wraps(func)
        def wrapper(session: nox.Session) -> None:
            deps: list[str] = []
            processing = False

            with Path(REQUIREMENTS_FILE).open() as f:
                for line in f:
                    if line.startswith("#") and line[2:].strip() == func.__name__:
                        processing = True
                        continue

                    if processing:
                        if line == "\n":
                            processing = False
                            break

                        deps.append(line.strip())

            args = ["-U", *deps]
            if meta:
                args.append(".")
            for x in rfiles or []:
                args.extend(["-r", f"requirements/{x}.txt"])

            session.install(*args)
            func(session)

        return wrapper

    return decorator


def sp(*paths: Path) -> list[str]:
    return [str(p) for p in paths]


@nox.session(reuse_venv=True)
@install(meta=True)
def alls(session: nox.Session) -> None:
    session.run("python", "scripts/alls.py")


@nox.session(reuse_venv=True)
@install()
def dependencies(session: nox.Session) -> None:
    session.run("deputil", "update", "requirements")


@nox.session(reuse_venv=True)
@install()
def formatting(session: nox.Session) -> None:
    session.run(
        "black",
        "--check",
        *sp(PROJECT_DIR, TEST_DIR, NOX_FILE, SETUP_FILE),
    )


@nox.session(reuse_venv=True)
def licensing(session: nox.Session) -> None:
    expd = "# Copyright (c) 2023-present, Parafoxia, Jonxslays"
    errors: t.List[Path] = []

    for path in (
        *PROJECT_DIR.rglob("*.py"),
        *TEST_DIR.rglob("*.py"),
        NOX_FILE,
        SETUP_FILE,
    ):
        with Path(path).open() as f:
            if not f.read().startswith(expd):
                errors.append(path)

    if errors:
        session.error(
            f"\n{len(errors):,} file(s) are missing their licenses:\n"
            + "\n".join(f" - {file}" for file in errors)
        )


@nox.session(reuse_venv=True)
@install()
def linting(session: nox.Session) -> None:
    session.run("ruff", "check", *sp(PROJECT_DIR, NOX_FILE))


@nox.session(reuse_venv=True)
@install(rfiles=["dev"])
def safety(session: nox.Session) -> None:
    session.run("safety", "check", "--full-report")


@nox.session(reuse_venv=True)
@install(meta=True)
def slots(session: nox.Session) -> None:
    session.run("slotscheck", "-m", PROJECT_NAME)


@nox.session(reuse_venv=True)
@install()
def spelling(session: nox.Session) -> None:
    session.run(
        "codespell", *sp(PROJECT_DIR, TEST_DIR, NOX_FILE, SETUP_FILE), "-L", "alls"
    )


@nox.session(reuse_venv=True)
@install(rfiles=["types"])
def typing(session: nox.Session) -> None:
    session.run("mypy", *sp(PROJECT_DIR, SETUP_FILE))
    session.run("pyright", *sp(PROJECT_DIR, SETUP_FILE))

noxfile.py
severndev/severn
# Copyright (c) 2023-present, Parafoxia, Jonxslays
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright notice, this
#        list of conditions and the following disclaimer.
#
#     2. Redistributions in binary form must reproduce the above copyright notice,
#        this list of conditions and the following disclaimer in the documentation
#        and/or other materials provided with the distribution.
#
#     3. Neither the name of the copyright holder nor the names of its
#        contributors may be used to endorse or promote products derived from
#        this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import sys
import typing as t

import severn


def should_include_module(module: str) -> bool:
    return (
        module != "annotations" and module[0] != "_" and module[0].upper() != module[0]
    )


def get_modules() -> t.List[str]:
    return [m for m in severn.__dict__ if should_include_module(m)]


def get_alls() -> t.Tuple[t.Set[str], t.Set[str]]:
    modules = get_modules()
    return (
        {item for module in modules for item in severn.__dict__[module].__all__},
        {i for i in severn.__all__ if i not in modules},
    )


def validate_alls() -> None:
    modules, lib = get_alls()
    err = None

    if missing := modules - lib:
        err = "Missing exported items at top level:\n" + "\n".join(
            f" - {m}" for m in missing
        )
        print(err, file=sys.stderr)

    if missing := lib - modules:
        err = "Missing exported items at module level:\n" + "\n".join(
            f" - {m}" for m in missing
        )
        print(err, file=sys.stderr)

    if err:
        sys.exit(1)


if __name__ == "__main__":
    validate_alls()

scripts/alls.py
severndev/severn
# Copyright (c) 2023-present, Parafoxia, Jonxslays
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#    1. Redistributions of source code must retain the above copyright notice, this
#       list of conditions and the following disclaimer.
#
#    2. Redistributions in binary form must reproduce the above copyright notice,
#       this list of conditions and the following disclaimer in the documentation
#       and/or other materials provided with the distribution.
#
#    3. Neither the name of the copyright holder nor the names of its
#       contributors may be used to endorse or promote products derived from
#       this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import sys
import typing as t
from pathlib import Path

import setuptools

if sys.version_info < (3, 8, 0):
    print("Severn only supports Python versions 3.8.0 or greater.", file=sys.stderr)
    sys.exit(1)


def parse_requirements(path: str) -> list[str]:
    with Path(path).open() as f:
        deps = (d.strip() for d in f.readlines())
        return [d for d in deps if not d.startswith(("#", "-e", "-r"))]


with Path("severn/__init__.py").open() as f:
    attrs: t.Dict[str, str] = {}

    for line in f:
        if not line.startswith("__"):
            continue

        k, v = line.split(" = ")
        if k == "__all__":
            continue

        attrs[k[2:-2]] = v.strip().replace('"', "")

setuptools.setup(
    name=attrs["productname"],
    version=attrs["version"],
    description=attrs["description"],
    long_description=Path("README.md").read_text(),
    long_description_content_type="text/markdown",
    url=attrs["url"],
    author=attrs["author"],
    # author_email=attrs["author_email"],
    license=attrs["license"],
    classifiers=[
        # "Development Status :: 1 - Planning",
        "Development Status :: 2 - Pre-Alpha",
        # "Development Status :: 3 - Alpha",
        # "Development Status :: 4 - Beta",
        # "Development Status :: 5 - Production/Stable",
        "Environment :: Console",
        "Framework :: AsyncIO",
        "Intended Audience :: Developers",
        "Intended Audience :: End Users/Desktop",
        "License :: OSI Approved :: BSD License",
        "Natural Language :: English",
        "Operating System :: MacOS",
        "Operating System :: Microsoft :: Windows",
        "Operating System :: OS Independent",
        "Operating System :: POSIX",
        "Operating System :: Unix",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3 :: Only",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: Implementation :: CPython",
        "Programming Language :: Python :: Implementation :: PyPy",
        "Topic :: Software Development",
        # "Topic :: Software Development :: Code Generators",
        "Topic :: Utilities",
        "Typing :: Typed",
    ],
    project_urls={
        # "Documentation": attrs["docs"],
        "Source": attrs["url"],
        "Bug Tracker": attrs["bugtracker"],
        "CI": attrs["ci"],
        "Changelog": attrs["changelog"],
    },
    install_requires=parse_requirements("requirements/base.txt"),
    # extras_require={},
    python_requires=">=3.8.0,<3.13",
    packages=setuptools.find_packages(),
    include_package_data=True,
)

setup.py
severndev/severn
# Copyright (c) 2023-present, Parafoxia, Jonxslays
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright notice, this
#        list of conditions and the following disclaimer.
#
#     2. Redistributions in binary form must reproduce the above copyright notice,
#        this list of conditions and the following disclaimer in the documentation
#        and/or other materials provided with the distribution.
#
#     3. Neither the name of the copyright holder nor the names of its
#        contributors may be used to endorse or promote products derived from
#        this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

__all__ = ()

__productname__ = "severn"
__version__ = "0.1.0"
__description__ = "Your new end-to-end project management system."
__url__ = "https://github.com/severndev/severn"
__docs__ = "https://severn.dev"
__author__ = "Parafoxia, Jonxslays"
__license__ = "BSD 3-Clause 'New' or 'Revised' License"
__bugtracker__ = "https://github.com/severndev/severn/issues"
__ci__ = "https://github.com/severndev/severn/actions"
__changelog__ = "https://github.com/severndev/severn/releases"

severn/__init__.py
severndev/severn
# Copyright (c) 2023-present, Parafoxia, Jonxslays
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright notice, this
#        list of conditions and the following disclaimer.
#
#     2. Redistributions in binary form must reproduce the above copyright notice,
#        this list of conditions and the following disclaimer in the documentation
#        and/or other materials provided with the distribution.
#
#     3. Neither the name of the copyright holder nor the names of its
#        contributors may be used to endorse or promote products derived from
#        this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import sys

from severn import __version__

BANNER = """
     ###########     #########  ####       ###    ##########   ###########    ##########
  ####            ####         ####       ###  ####           ###      ####  ####     ####
   ##########   ############   ####      ###  ############   ###      ####  ###      ####
          ####  ####            ###     ###   ####          ##########     ####     ####
############     ##########      #########     ##########  ####     ###   ####     ####
"""  # noqa: E501

if __name__ == "__main__":
    sys.stdout.write(f"{BANNER}\nSevern v{__version__}\n")

severn/__main__.py
severndev/severn