CodeBlanks Logo Icon CodeBlanks
Login Register

pyproject.toml

Learn project configuration with pyproject.toml.

pyproject.toml

pyproject.toml is the configuration file of a modern Python project. The project name, version and dependencies are declared here. The format is TOML; in Python 3.12 it is read from the standard library with the tomllib module.

[project]
name = "demo"
version = "0.1.0"

The file contains at least a [project] table. This table holds the package identity and requirements; pip and build tools read from it.

The [project] table

The required fields of the [project] table are name and version. The dependencies field lists the packages the project needs to run.

[project]
name = "demo"
version = "0.1.0"
dependencies = ["requests>=2.28"]

name is the package name shown on PyPI; version is the semantic version. Together these three fields form the package identity used by pip.

Practice Read the project name with tomllib

Start with import tomllib. Convert the TOML string below into structured data with tomllib.loads(...) and assign it to data:

[project]
name = "demo"
version = "0.1.0"

Then print the project name with print(data["project"]["name"]).

Starter code

main.py
# bring in the tomllib module
# load the pyproject content as structured data
# print the name field of the project table

Sample solution

main.py
import tomllib

data = tomllib.loads('''
[project]
name = "demo"
version = "0.1.0"
''')

print(data["project"]["name"])

Expected output

demo

Questions and answers

Review the lesson questions together with their answers. To test yourself, solve the lesson interactively.

1 Which table holds the project identity in pyproject.toml?

  • [package]
  • [build-system]
  • [tool]
  • [project] Correct answer

Explanation: The [project] table holds name, version and dependencies.

2 Complete the name line

Question 
[project]
____ = "demo"
Answer 
[project]
name = "demo"

Explanation: The name field holds the package name.

3 Match the pyproject.toml tables

Term Meaning
[project] Package identity
[build-system] Build tool
name Package name
version Version

All lessons in Advanced

1 Advanced decorators

  1. Parameterized decorator
  2. Class decorator
  3. functools
  4. functools.partial
  5. functools.reduce
  6. Summary - Advanced decorators

2 Type hints

  1. Basic hints
  2. Optional and Union
  3. typing.List and Dict
  4. Callable
  5. TypeVar
  6. Summary - Type hints

3 Pytest

  1. pytest basics
  2. assert
  3. fixture
  4. parametrize
  5. monkeypatch
  6. Summary - Pytest

4 Mocking

  1. unittest.mock
  2. patch
  3. MagicMock
  4. side_effect
  5. assert_called
  6. Summary - Mocking

5 Async basics

  1. async/await
  2. asyncio.run
  3. async def
  4. await asyncio.sleep
  5. create_task
  6. Summary - Async basics

6 Asyncio

  1. gather
  2. wait
  3. Queue
  4. Lock
  5. Semaphore
  6. Summary - Asyncio

7 HTTP and aiohttp

  1. urllib
  2. aiohttp.ClientSession
  3. async get
  4. async post
  5. JSON response
  6. Summary - HTTP and aiohttp

8 SQLAlchemy

  1. Engine
  2. Session
  3. Defining models
  4. Column and type
  5. Query
  6. Summary - SQLAlchemy

9 FastAPI

  1. FastAPI app
  2. @app.get
  3. Pydantic model
  4. Path parameter
  5. Query parameter
  6. Summary - FastAPI

10 Pydantic

  1. BaseModel
  2. Field
  3. validator
  4. Config
  5. parse_obj
  6. Summary - Pydantic

11 Design patterns

  1. Singleton
  2. Factory
  3. Strategy
  4. Observer
  5. Decorator
  6. Summary - Design patterns

12 Logging

  1. logging.getLogger
  2. Log levels
  3. basicConfig
  4. FileHandler
  5. dictConfig
  6. Summary - Logging

13 Packaging

  1. pyproject.toml
  2. setuptools
  3. Virtual environment
  4. pip install
  5. requirements.txt
  6. Summary - Packaging

14 Advanced final

  1. Project design
  2. Async layer
  3. SQLAlchemy layer
  4. FastAPI layer
  5. Putting it together