Draft Introduction #9
Conversation
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/christopher-wild/FAIR4RS-Packaging/compare/md-outputs..md-outputs-PR-9 The following changes were observed in the rendered markdown documents: What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2024-05-31 10:50:07 +0000 |
| ``` | ||
| 📦 my_project/ | ||
| ├── 📂 my_package/ | ||
| │ └── 📄 __init__.py |
There was a problem hiding this comment.
Since pep420 __init__.py are optional, I don't really use them for example.
Is it worth not mentioning them to avoid questions / confusion about what they are?
There was a problem hiding this comment.
@christopher-wild Agreed that __init.py isn't needed in this example, but there's a big difference between regular packages and namespace packages. Also, backwards compatibility is an important consideration here too.
I'll make a callout to clarify this point as I think it's important to know.
There was a problem hiding this comment.
There is that difference but I dont think I've ever come across a package that has made use of splitting the package contents among multiple paths with the same namespace. It sounds like a very complicated structure!
episodes/introduction.md
Outdated
| - 📦 `my_project/` is the root directory of the project. | ||
| - 📂 `my_package/` is the package directory containing the source code. | ||
| - 📄 `__init__.py` is an initialisation script (note; this also lets Python know that there are importable modules in this directory). | ||
| - 📄 `setup.py` is a script for setting up the package, containing basic metadata. Tools such as `setuptools` and `pip` use this script to configure how the package is built, distributed, and installed. |
There was a problem hiding this comment.
Should the example file be a pyproject.toml file as that is the latest standard?
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : e46bb6c
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-05-31 10:51:26 +0000
Message : markdown source builds
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : befd4d3
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-06-04 01:15:19 +0000
Message : markdown source builds
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : 8a6899a
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-06-11 01:16:29 +0000
Message : markdown source builds
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
Auto-generated via {sandpaper}
Source : dbe5e00
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-06-18 01:16:32 +0000
Message : markdown source builds
Auto-generated via {sandpaper}
Source : 64f4553
Branch : main
Author : Farhad Allian <[email protected]>
Time : 2024-05-31 10:50:33 +0000
Message : Merge pull request #9 from christopher-wild/f-allian-branch
Introduction
@christopher-wild Let me know what you think of this too - will be working on semantic versioning today :)