2011-04-15 06:28:21 +00:00
|
|
|
Developing LinkChecker
|
|
|
|
|
======================
|
2017-02-10 13:51:26 +00:00
|
|
|
|
2011-04-15 06:28:21 +00:00
|
|
|
The following steps describe how to compile LinkChecker from source
|
|
|
|
|
on various platforms.
|
|
|
|
|
|
2017-02-10 13:51:26 +00:00
|
|
|
This is a technical document, if you are looking for ways to
|
|
|
|
|
participate in the community, you should rather look into
|
|
|
|
|
[contributing](contributing).
|
2011-04-15 06:28:21 +00:00
|
|
|
|
|
|
|
|
Requirements
|
|
|
|
|
------------
|
2011-04-25 13:44:20 +00:00
|
|
|
On Mac OS X systems, using MacPorts, Fink or homebrew for software
|
|
|
|
|
installation is recommended.
|
2011-04-15 06:28:21 +00:00
|
|
|
|
2012-06-22 21:58:20 +00:00
|
|
|
- Install Python >= 2.7.2 from http://www.python.org/
|
2011-04-15 06:28:21 +00:00
|
|
|
|
2011-11-05 13:08:20 +00:00
|
|
|
- *On Windows only*, install the Windows SDK
|
|
|
|
|
http://msdn.microsoft.com/de-de/windows/bb980924
|
2011-04-15 06:28:21 +00:00
|
|
|
|
2011-04-25 13:44:20 +00:00
|
|
|
- *On Windows only*, download and install the Microsoft
|
|
|
|
|
Visual C++ 2008 runtime from
|
|
|
|
|
http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en
|
2011-04-15 06:28:21 +00:00
|
|
|
|
2011-04-25 13:44:20 +00:00
|
|
|
- *Optional, used for Virus checking:*
|
|
|
|
|
ClamAv for Unix from http://www.clamav.net/lang/en/download/
|
|
|
|
|
or for Windows from http://www.sosdg.org/clamav-win32/
|
2011-04-15 06:28:21 +00:00
|
|
|
|
2011-04-25 13:44:20 +00:00
|
|
|
- *Optional, for displaying country codes:*
|
|
|
|
|
Pygeoip from http://code.google.com/p/pygeoip/
|
|
|
|
|
|
2011-04-15 06:28:21 +00:00
|
|
|
|
|
|
|
|
Setup for Unix/Linux
|
|
|
|
|
--------------------
|
|
|
|
|
Execute ``make localbuild`` to compile a local version and execute
|
2016-01-23 12:28:15 +00:00
|
|
|
``./linkchecker``.
|
2011-04-15 06:28:21 +00:00
|
|
|
Execute ``make test`` to run the unittest suite.
|
|
|
|
|
Execute ``make dist`` to build a distributable source package.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Setup for Mac OS X
|
|
|
|
|
------------------
|
|
|
|
|
Execute ``make localbuild`` to compile a local version and execute
|
2016-01-23 12:28:15 +00:00
|
|
|
``./linkchecker``.
|
2011-04-15 06:28:21 +00:00
|
|
|
Execute ``make test`` to run the unittest suite.
|
2011-04-25 13:44:20 +00:00
|
|
|
Execute ``make app`` to build a distributable source package.
|
2011-04-15 06:28:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Setup for Windows
|
|
|
|
|
-----------------
|
2011-04-25 13:44:20 +00:00
|
|
|
Execute ``windows\build.bat`` to build a local version.
|
|
|
|
|
Execute ``windows\test.bat`` to run the unittest suite.
|
|
|
|
|
Execute ``windows\dist.bat`` to build a binary installer.
|
2017-01-31 17:25:57 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Release process
|
|
|
|
|
---------------
|
|
|
|
|
|
2022-08-23 18:21:53 +00:00
|
|
|
1. check whether updated man pages and translations need committing
|
2021-01-28 19:20:24 +00:00
|
|
|
(`make locale; make -C doc locale; make -C doc man`)
|
2022-08-23 18:21:53 +00:00
|
|
|
if so create a pull request using the GitHub workflow:
|
|
|
|
|
"Create a branch with updated man pages and application translations"
|
2017-01-31 17:25:57 +00:00
|
|
|
|
2022-02-22 19:35:04 +00:00
|
|
|
2. edit `changelog.txt` and `upgrading.txt`, and if applicable the
|
|
|
|
|
copyright dates in `linkcheck/configuration/__init__.py`
|
2017-01-31 17:25:57 +00:00
|
|
|
|
2021-01-28 19:20:24 +00:00
|
|
|
3. confirm tests have passed
|
2017-01-31 17:25:57 +00:00
|
|
|
|
2021-01-28 19:20:24 +00:00
|
|
|
4. submit a pull request
|
2017-01-31 17:25:57 +00:00
|
|
|
|
2021-12-06 19:40:14 +00:00
|
|
|
5. create release (vX.Y.Z) on GitHub
|
2017-01-31 17:25:57 +00:00
|
|
|
|
2022-08-23 18:21:53 +00:00
|
|
|
6. download Python distribution files from the GitHub release
|
2021-01-28 19:20:24 +00:00
|
|
|
|
2022-08-23 18:21:53 +00:00
|
|
|
7. check distribution files (`twine check LinkChecker*`) and upload to PyPI (`twine upload LinkChecker*`)
|
