/
pyproject.toml
62 lines (57 loc) · 2.1 KB
/
pyproject.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# {==(1) Annotating our package==}
# First we define some basic descriptions about our project.
# More information about valid sections can be found in this link:
# https://python-poetry.org/docs/master/pyproject/
[tool.poetry]
name = "quizli"
homepage = "https://github.com/pwenker/quizli"
documentation = "https://pwenker.github.io/quizli"
version = "1.0.0"
description = "An educational project teaching how to open-source an interactive Python quiz app"
authors = ["Pascal Wenker <pwenker@posteo.de>"]
readme = "README.md"
license = "MIT"
classifiers = [ # https://pypi.org/classifiers/
"Programming Language :: Python :: 3 :: Only",
"Environment :: Console",
"Intended Audience :: Education",
"Intended Audience :: Developers",
"Natural Language :: English",
"Topic :: Documentation",
"Topic :: Education",
"Topic :: Software Development",
"Typing :: Typed",
]
# {==(2) Defining an entrypoint for our CLI==}
# Here we define the entrypoint to our app. Since we want to let
# users run the app with the `quizli` command, we define it as such
# below
[tool.poetry.scripts]
quizli = "quizli.main:app"
# {==(3) Declaring Dependencies==}
# The following section defines the dependencies of our project.
# Note that poetry lets us split them up in
# - regular dependencies, and
# - dev-dependencies.
# In this way, a users can install it with `poetry install --no-dev`
# to not install the development dependencies they don't need.
[tool.poetry.dependencies]
python = "^3.8"
rich = "^11.0.0"
typer-cli = "^0.0.12"
[tool.poetry.dev-dependencies]
# Testing
pytest = "^7.0.1"
pytest-cov = "^3.0.0"
typing-extensions = "^4.1.1"
# Documentation
mkdocs-material = "^8.1.8"
## Plugins
mkdocstrings = "^0.17.0"
mkdocs-jupyter = "^0.19.0"
mkdocs-git-revision-date-localized-plugin = "^1.0.0"
# {==(4) Setting the build-sytem==}
# Here, we declare that we want poetry to build our package.
[build-system] # See: https://www.python.org/dev/peps/pep-0518/#id27
requires = ["poetry-core>=1.0.0"] # For more information see: PEP 518
build-backend = "poetry.core.masonry.api" # For more information see: PEP 517