Skip to content

Commit f3c20de

Browse files
authored
Fix: ordered list on complex package page (#62)
* One more image fix * Fix: quick fix to issue with complex package ordered list' * Fix ordered list
1 parent 636ca60 commit f3c20de

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

package-structure-code/complex-python-package-builds.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ You can classify Python package complexity into three general categories. These
1111
categories can in turn help you select the correct package front-end and
1212
back-end tools.
1313

14-
1. **Pure-python packages:** these are packages that only rely on Python to function. Building a pure Python package is simpler. As such, you can chose a tool below that
15-
has the features that you want and be done with your decision!
16-
2. **Python packages with non-Python extensions:** These packages have additional components called extensions written in other languages (such as C or C++). If you have a package with non-python extensions, then you need to select a build back-end tool that allows you to add additional build steps needed to compile your extension code. Further, if you wish to use a front-end tool to support your workflow, you will need to select a tool that
17-
supports additional build setps. In this case, you could use setuptools. However, we suggest that you chose build tool that supports custom build steps such as Hatch with Hatchling or PDM. PDM is an excellent choice as it allows you to also select your build back-end of choice. We will discuss this at a high level on the complex builds page. 3.**Python packages that have extensions written in different languages (e.g. Fortran and C++) or that have non Python dependencies that are difficult to install (e.g. GDAL)** These packages often have complex build steps (more complex than a package with just a few C extensions for instance). As such, these packages require tools such as [scikit-build](https://scikit-build.readthedocs.io/en/latest/)
14+
1. **Pure-python packages:** these are packages that only rely on Python to function. Building a pure Python package is simpler. As such, you can chose a tool below that has the features that you want and be done with your decision!
15+
16+
2. **Python packages with non-Python extensions:** These packages have additional components called extensions written in other languages (such as C or C++). If you have a package with non-python extensions, then you need to select a build back-end tool that allows you to add additional build steps needed to compile your extension code. Further, if you wish to use a front-end tool to support your workflow, you will need to select a tool that supports additional build setups. In this case, you could use setuptools. However, we suggest that you chose build tool that supports custom build steps such as Hatch with Hatchling or PDM. PDM is an excellent choice as it allows you to also select your build back-end of choice. We will discuss this at a high level on the complex builds page.
17+
18+
3. **Python packages that have extensions written in different languages (e.g. Fortran and C++) or that have non Python dependencies that are difficult to install (e.g. GDAL)** These packages often have complex build steps (more complex than a package with just a few C extensions for instance). As such, these packages require tools such as [scikit-build](https://scikit-build.readthedocs.io/en/latest/)
1819
or [meson-python](https://mesonbuild.com/Python-module.html) to build. NOTE: you can use meson-python with PDM.

package-structure-code/python-package-build-tools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ extensions.
1010

1111
:::{figure-md} fig-target
1212

13-
<img src="../images/python-package-tools-decision-tree.svg" alt="Figure showing... will finish this once we are all happy with the figure and it's not going to change more..." width="700px">
13+
<img src="../images/python-package-tools-decision-tree.png" alt="Decision tree diagram showing the various front and back end packaging tools. You can decide what packaging tool to use by thinking about what features you need. PDM is currently the most flexible tool that also supports both non pure Python projects and also using different build back-ends. As such currently PDM is the tool we think beginners might appreciate most with Poetry being a close second. Poetry is ideal for pure python projects." width="700px">
1414

1515
Diagram showing the various from end build tools that you can select from. Each tool has different features as highlighted below.
1616
NOTE: this is still a DRAFT so i'm not going to spend time truly cleaning it up until i get lots of feedback on the general approach!!

0 commit comments

Comments
 (0)