Skip to content

Commit 7a1761e

Browse files
lwasserlwasser
committed
Clean up redundant sections
1 parent c1fff86 commit 7a1761e

File tree

1 file changed

+35
-60
lines changed

1 file changed

+35
-60
lines changed

‎_posts/events/2025-06-24-scipy25-create-python-package.md‎

Lines changed: 35 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -61,62 +61,36 @@ If you're comfortable with Python environments, arrive with an environment that
6161
- You can install both via `pipx`, `uv`, pixi, or any preferred package manager.
6262
- [VS Code](https://code.visualstudio.com/download) (or any IDE you prefer for packaging)
6363

64-
> <i class="fa-solid fa-triangle-exclamation"></i> **Note:** JupyterLab or Jupyter Notebook is **not ideal** for the packaging work we’ll be doing.
64+
> <i class="fa-solid fa-triangle-exclamation"></i> **Note:**
65+
> * We strongly suggest that you go to GitHub.com and [Fork our SciPy 2025 workshop repository](https://github.com/pyOpenSci/pyopensci-scipy25-create-python-package) just in case something with your local installation isn't working. This will ensure that you can follow along with us regardless of your environment setup!
66+
> * JupyterLab or Jupyter Notebook is **not ideal** for the packaging work we’ll be doing.
6567
{: .notice }
6668

6769
If you run into issues, please [join our Discord and ask for help](https://discord.gg/m7RFFxnc) before the workshop.
6870

6971

7072
## 2b. If you plan to use GitHub Codespaces (SUGGESTED)
7173

72-
We strongly suggest that you use our curated [GitHub Codespace](https://codespaces.new/pyOpenSci/ff-2024-create-python-package?quickstart=1), which you can find in your forked workshop repository. This workspace is already set up with
74+
We strongly recommend using our curated [GitHub Codespace](https://codespaces.new/pyOpenSci/ff-2024-create-python-package?quickstart=1), which can be found in your forked workshop repository. This workspace is already set up with:
7375

74-
* VSCode, copier, Hatch, and everything you need to successfully create your first Python package. Codespaces also allows you to easily commit your work during the workshop to your own forked GitHub repository.
76+
* VSCode, copier, Hatch, and everything you need to create your first Python package successfully. Codespaces also allows you to easily commit your work during the workshop to your own forked GitHub repository.
7577

76-
### Before the workshop do the following
78+
**Before the workshop do the following**
7779

78-
* Go to GitHub.com and [Fork the workshop repository](https://github.com/pyOpenSci/pyopensci-scipy25-create-python-package)
80+
* Go to GitHub.com and [Fork our SciPy 2025 workshop repository](https://github.com/pyOpenSci/pyopensci-scipy25-create-python-package)
7981

8082
<figure>
8183
<picture>
8284
<img src="{{ site.baseurl }}/images/github/codespaces/scipy-fork-repo.gif" alt=".">
8385
</picture>
8486
</figure>
8587

86-
* **Create a branch** in your fork to work on during the workshop.
87-
* **Launch the repository codespace from your fork, BEFORE the workshop begins**. The initial spin-up for a codespace can take up to 15 minutes or longer. Once it's been created, it will be quicker to relaunch.
88+
* Launch the codespace before the workshop:
8889

89-
<figure>
90-
<picture>
91-
<img src="{{ site.baseurl }}/images/github/codespaces/scipy-open-codespace.gif" alt=".">
92-
</picture>
93-
</figure>
94-
95-
96-
## <i class="fa-solid fa-cloud"></i> About GitHub Codespaces: Working in the cloud
97-
98-
99-
## What is a codespace
100-
101-
GitHub Codespaces are cloud-based development environments that let you
102-
code directly in your browser—no local setup needed. They provide fully
103-
configured, container-based environments connected to your GitHub
104-
repository.
105-
106-
You can customize Codespaces with `.devcontainer` files to match your
107-
development setup. The Codespace for this workshop opens in Visual Studio
108-
Code by default, but you can configure it to use any IDE you prefer.
109-
110-
Learn more in the [GitHub Codespaces docs](https://docs.github.com/en/codespaces/overview).
111-
112-
Codespaces are free for up to 60 hours/month on GitHub’s free plan. Be sure
113-
to shut yours down after the workshop to conserve your allocated time.
114-
{: .notice}
115-
116-
117-
### How to open a codespace
90+
<i class="fa-solid fa-circle-info"></i> The initial spin-up for a codespace can take up to 15 minutes or longer. Once GitHub creates the cloud environment, it will be quicker to relaunch. Please do this before attending the workshop session.
91+
{: .notice }
11892

119-
To open a Codespace,
93+
To open your Codespace,
12094

12195
* Go to your forked SciPy 2025 workshop repository on GitHub,
12296
* Switch to a branch that you want to work on during the workshop,
@@ -126,7 +100,9 @@ To open a Codespace,
126100
Within the Codespaces tab you will see a button: <kbd style="background-color: #2da44e; color: white; padding: 2px 6px; border-radius: 4px;">
127101
Create codespace on main
128102
</kbd>. This button launches a Codespace from the currently active branch. It will default to the
129-
`main` branch if you haven't changed your branch yet.
103+
`main` branch if you haven't changed your branch in the repository.
104+
105+
The animated gif below walks you through how this works.
130106

131107
<figure style="width: 55%; margin: 0 auto;">
132108
<picture>
@@ -138,18 +114,26 @@ Create codespace on main
138114
</figure>
139115

140116
> <i class="fa-solid fa-circle-info"></i> To follow GitHub best practices, always create a new branch before making
141-
> changes. Avoid working directly on the `main` branch.
117+
> changes to a repository, even if you own the repository. Avoid working directly on the `main` branch.
142118
143-
If you switch branches in GitHub, Codespaces will launch from the
144-
selected, active branch.
119+
## <i class="fa-solid fa-cloud"></i> About GitHub Codespaces: Working in the cloud
145120

146-
<figure>
147-
<picture>
148-
<img src="{{ site.baseurl }}/images/github/codespaces/scipy-open-codespace.gif"
149-
alt="GIF showing Codespace launch process">
150-
</picture>
151-
</figure>
121+
## What is a codespace
122+
123+
GitHub Codespaces are cloud-based development environments that let you
124+
code directly in your browser—no local setup needed. They provide fully
125+
configured, container-based environments connected to your GitHub
126+
repository.
127+
128+
You can customize Codespaces with `.devcontainer` files to match your
129+
development setup. The Codespace for this workshop opens in Visual Studio
130+
Code by default, but you can configure it to use any IDE you prefer.
152131

132+
Learn more in the [GitHub Codespaces docs](https://docs.github.com/en/codespaces/overview).
133+
134+
Codespaces are free for up to 60 hours/month on GitHub’s free plan. Be sure
135+
to shut yours down after the workshop to conserve your allocated time.
136+
{: .notice}
153137

154138
> Codespaces are associated with your **personal GitHub account**, even if
155139
you open one from the pyOpenSci repository. The usage counts toward your
@@ -164,14 +148,7 @@ to start from scratch. GitHub will reuse the environment, making it launch
164148
significantly faster the second time.
165149

166150
If possible, resume the **same Codespace** you started in, rather than
167-
creating a new one in your fork.
168-
169-
<figure>
170-
<picture>
171-
<img src="{{ site.baseurl }}/images/github/codespaces/scipy-open-codespace.gif"
172-
alt="Animated gif of GitHub Codespace launch names">
173-
</picture>
174-
</figure>
151+
creating a new one in your fork. Read on to learn how to find and reopen a codespace.
175152

176153
<i class="fa-solid fa-link"></i>
177154
[View all active Codespaces associated with your account](https://github.com/codespaces)
@@ -183,7 +160,6 @@ creating a new one in your fork.
183160
> [Learn more in the GitHub docs](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)
184161
185162

186-
As you can see in the animated gif below, GitHub codespaces always have fun names.
187163

188164

189165
### How to relaunch a codespace
@@ -193,10 +169,9 @@ To relaunch a Codespace:
193169
1. Go to your fork of the workshop repository.
194170
2. Click the **Code** dropdown (same as when you first created the Codespace).
195171
3. Select the **Codespaces** tab to view existing environments.
196-
4. If GitHub finds a matching Codespace, it will prompt you to:
197-
198-
<i class="fa-solid fa-play"></i> **Resume this Codespace**
172+
4. Select the codespace that you want to resume from the list (see image below).
199173

174+
As you can see in the animated gif below, GitHub codespaces always have fun names.
200175

201176
<figure>
202177
<picture>
@@ -210,7 +185,7 @@ To relaunch a Codespace:
210185
<i class="fa-solid fa-users-line"></i> Connect with us!
211186
{: .header }
212187

213-
There are lots of ways to get involved if you are interested!
188+
There are many ways to get involved if you're interested!
214189

215190
* If you read through our lessons and want to suggest changes, open an issue in our [lessons repository here](https://github.com/pyOpenSci/lessons)
216191
* [Volunteer to be a reviewer for pyOpenSci's software review process](https://forms.gle/GHfxvmS47nQFDcBM6)

0 commit comments

Comments
 (0)