Quick start

pipx install linkmedic

linkmedic --root=/var/www/

Usage

Please refer to the user’s guide for details on the available options to install linkmedic and its usage.

Development and Maintenance

This repository is frequently used as a template for configuring Python development environments and CI/CD pipelines. It is intentionally designed with strict boundaries while prioritizing scalability and maintainability. Third-party dependencies are minimized to support this goal. The design goal is to have the option of running CI pipelines locally in an identical environment. PDM tracks exact Python dependency versions and hashes, which are detailed in its PEP 751 lockfile pylock.toml.

Code coverage is intentionally not 100%. While several testing approaches are demonstrated, the focus is on showcasing practical methods rather than achieving complete coverage.

Versioning is dynamic, based on Git tags. Project documentation is versioned, and its HTML output is automatically built and deployed here.

CI and release container recipes (Dockerfiles) are versioned, with OS packages sourced from the latest minor version of their base OS image at build time.

Refer to the developer’s guide for code development details, and maintainer’s guide for maintenance and release.

Security and Privacy Considerations

To respect user privacy, linkmedic does not send any data (e.g., telemetry, crash reports) to developers or third parties. However, when checking external links (with --check-external flag), it has to connect to other servers to verify the links, which exposes the testing machine’s external IP address. This also discloses the domain name of your links to your test environment’s DNS.

Reporting Issues

Before reporting an issue:

1. Check the Known Issues section in the user’s guide for solutions to frequent problems.

2. Run linkmedic with the --verbose flag for detailed error information.

If unresolved, report bugs and code-related issues here. If you have an MPCDF account, use the upstream repository instead. Please include in your report relevant information such as:

• Your installation method

• Python interpreter details: python -c "import sys; print(sys.version)"

• Installed packages in the environment: pipx list or pip freeze

• Minimal HTML pages and the command you used to run linkmedic for reproducing the issue

• Verbose linkmedic logs

History

The original idea for this project came from Dr. Klaus Reuter (MPCDF). Fruitful discussions with Dr. Sebastian Kehl (MPCDF) facilitated the packaging and release of this project.

Accompanying tools for linkmedic have been moved to a separate repositories:

• linkmedkit: starting with version 0.7

• ndx: starting with version 0.10

The laboratory module has been adapted from pre-commit-localupdate project.

License

• Copyright 2021-2023 M. Farzalipour Tabriz, Max Planck Computing and Data Facility (MPCDF)

• Copyright 2023-2026 M. Farzalipour Tabriz, Max Planck Institute for Physics (MPP)

All rights reserved.

This software is distributed under a combination of the 3-Clause BSD License and the GNU Lesser General Public License (LGPL). The license for each individual file is specified in its header. See the LICENSES directory for further details.