Skip to content

Commit 29af335

Browse files
committed
Make dir structure clearer
1 parent c0705b1 commit 29af335

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

notebooks/beginner/html/project_structure.html

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11869,29 +11869,27 @@ <h2 id="Python-script">Python script<a class="anchor-link" href="#Python-script"
1186911869
<div class="text_cell_render border-box-sizing rendered_html">
1187011870
<h2 id="Python-package">Python package<a class="anchor-link" href="#Python-package">&#182;</a></h2><p>An example structure for a python project:</p>
1187111871

11872-
<pre><code>my_project
11873-
11872+
<pre><code>my_project/
1187411873
README.md
1187511874
requirements.txt
1187611875
setup.py
1187711876

11878-
src
11879-
my_project
11877+
src/
11878+
my_project/
1188011879
__init__.py
1188111880
my_module.py
1188211881
other_module.py
1188311882

11884-
my_pkg1
11883+
my_pkg1/
1188511884
__init__.py
1188611885
my_third_module.py
1188711886

11888-
11889-
tests
11887+
tests/
1189011888
conftest.py
1189111889
test_module.py
1189211890
test_other_module.py
1189311891

11894-
my_pkg1
11892+
my_pkg1/
1189511893
test_my_third_module.py</code></pre>
1189611894
<ul>
1189711895
<li><a href="https://pip.pypa.io/en/latest/user_guide/#requirements-files">requirements.txt</a> lists the Python packages from which my_project depends on.<ul>

notebooks/beginner/project_structure.ipynb

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,29 +53,27 @@
5353
"An example structure for a python project:\n",
5454
"\n",
5555
"```\n",
56-
"my_project\n",
57-
"\n",
56+
"my_project/\n",
5857
" README.md\n",
5958
" requirements.txt\n",
6059
" setup.py\n",
6160
" \n",
62-
" src\n",
63-
" my_project\n",
61+
" src/\n",
62+
" my_project/\n",
6463
" __init__.py\n",
6564
" my_module.py\n",
6665
" other_module.py\n",
6766
" \n",
68-
" my_pkg1\n",
67+
" my_pkg1/\n",
6968
" __init__.py\n",
7069
" my_third_module.py\n",
7170
" \n",
72-
" \n",
73-
" tests\n",
71+
" tests/\n",
7472
" conftest.py\n",
7573
" test_module.py\n",
7674
" test_other_module.py\n",
7775
" \n",
78-
" my_pkg1\n",
76+
" my_pkg1/\n",
7977
" test_my_third_module.py\n",
8078
"\n",
8179
"```\n",

0 commit comments

Comments
 (0)