API Reference building locally but not on RTH - missing path?

Questions about Python Packaging & Code
7

@AlexanderJuestel what a great start!

a few notes on your pr
each section starts with a [text-here].
You can think of the items below that as list elements in some ways. so for example your build-system looks like this

[build-system]
requires = ["setuptools>=68.1.2",
            "wheel",
            "setuptools_scm[toml]>=6.2"]
            
build-backend = "setuptools.build_meta"

it should look like this instead. you can remove wheel now because it should install automagically with the newer versions of setuptools!

[build-system]
requires = ["setuptools>=68.1.2",
            "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

Below i’ve removed the commented out maintainers section (that is an optional section)

[project]
name = "GemGIS"
authors = [
    {name = "Alexander Jüstel", email = "alexander.juestel@rwth-aachen.de"},
]
description = "Spatial data processing for geomodeling"
keywords = ["visualization", "python", "processing", "jupyter", "modeling", "geospatial", "jupyter-notebook",
            "geographic-data", "spatial-data", "notebooks", "raster-data", "vector-data", "geographic", "geomodeling"]
readme = "README.md"
license = {file = LICENSE}
dynamic = ["Version"]
requires-python = ">=3.8"
classifiers = [
    'Development Status :: 5 - Production/Stable',
    'Intended Audience :: Science/Research',
    'Topic :: Scientific/Engineering :: Information Analysis',
    'Programming Language :: Python :: 3.8',
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'License :: OSI Approved :: LGPL-3.0-only License', #
    'Operating System :: OS Independent',
]
dependencies = [
    "geopandas",
    "rasterio",
    "pyvista",
]

  1. i think your license will throw an error - it needs to be in the list of valid classifiers listed on pypi to be recognized in the metadata.

  2. And are you using dynamic versioning? if you are we can leave setuptools_scm there and set that up. what that means is that setuptools will derive the version from a git tag that you create rather than you having to bump it yourself

However, I find it quite difficult to know what to add, what options there are etc. your commented code already helps a lot but maybe an overview of what can be put in a project.toml file could be something for your website in the future?

Great timing! We are working on a pyproject.toml tutorial now. .

So what would you like to see? do you want to see

  • ALL elements that could go into the metadata for such a file
  • which are required
  • options for required elements that have format and word requirements such as the python version classifiers??

Feel free to add comments to that google doc above. we will be sprinting on creating these resources over the next months as a community with the first meeting starting today!