Skip to content

Commit e426acf

Browse files
committed
Merge remote-tracking branch 'origin/development' into development
2 parents 0221134 + f5a7b29 commit e426acf

29 files changed

+1548
-242
lines changed

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ dist/
1414
downloads/
1515
eggs/
1616
.eggs/
17-
lib/
18-
lib64/
1917
parts/
2018
sdist/
2119
var/

source-code/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ was used to develop it.
66

77
## What is it?
88

9+
1. `api-design`: illustrates how to design APIs in Python.
910
1. `context-manager`: illustrates how to write your own context managers.
1011
1. `coroutines`: illustrates how to write coroutines in Python.
1112
1. `decorators`: illustrates how to write decorators in Python.
@@ -32,3 +33,9 @@ was used to develop it.
3233
1. `code-organization`: illustration of how to organize code in packages
3334
and modules.
3435
1. `error-handling`: simple illustration of error handling.
36+
1. `pyinstaller`: illustration of how to use `pyinstaller` to create
37+
standalone executables.
38+
1. `text-resources`: illustration on how to include text resources in
39+
a package and conveniently access them.
40+
1. `pydantic.ipynb`: illustration of how to use the `pydantic` library
41+
for data validation.

source-code/api-design/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# API design
2+
3+
Designing an API is an important part of the software development process. It
4+
is the contract that defines how software components are used and interact. A
5+
well-designed API helps developers as well as users to understand the
6+
functionality of the software and how to use it. It also contributes to the
7+
maintainability and scalability of the software.
8+
9+
10+
## What is it?
11+
12+
1. `positional_vs_keyword_arguments.ipynb`: Jupyter notebook that illustrates
13+
the difference between positional and keyword arguments in Python, and how
14+
to enforce the use of either.

0 commit comments

Comments
 (0)