Skip to content

Commit 150a5b5

Browse files
committed
Fix: conda-forge fixes throughout
1 parent 9aeefbd commit 150a5b5

File tree

4 files changed

+13
-9
lines changed

4 files changed

+13
-9
lines changed

package-structure-code/publish-python-package-pypi-conda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Below you will learn more specifics about the differences between PyPI and conda
2323

2424
<img src="../images/publish-python-package-pypi-conda.png" alt="Image showing the progression of creating a Python package, building it and then publishing to PyPI and conda-forge. You take your code and turn it into distribution files (sdist and wheel) that PyPI accepts. then there is an arrow towards the PyPI repository where ou publish both distributions. From PyPI if you create a conda-forge recipe you can then publish to conda-forge. " width="700px">
2525

26-
Once you have published both package distributions (the source distribution and the wheel) to PyPI, you can then publish to conda-forge. Conda forge requires a source distribution on PyPI in order to build your package on conda-forge. You do not need to rebuild your package to publish to conda-forge.
26+
Once you have published both package distributions (the source distribution and the wheel) to PyPI, you can then publish to conda-forge. conda-forge requires a source distribution on PyPI in order to build your package on conda-forge. You do not need to rebuild your package to publish to conda-forge.
2727
:::
2828

2929
## What is PyPI
@@ -72,7 +72,7 @@ packages. These repositories are known as channels (discussed below).
7272
The conda ecosystem evolved years ago to provide support for and
7373
simplify the process of managing software dependencies in scientific
7474
The conda ecosystem evolved years ago to provide support for, and
75-
simplify the process of, managing software dependencies in scientific
75+
simplify the process of, managing software dependencies in scientific
7676
Python projects.
7777

7878
Many of the core scientific Python projects depend upon or wrap around tools and extensions that are written in other languages, such as C++. In the early stages of the scientific ecosystem's development, these non-Python extensions and tools were not well supported on PyPI, making publication difficult. In recent years there is more support for complex builds that allow developers to bundle non-Python code into a Python distribution using the [wheel distribution format](python-wheel).

tutorials/intro.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ create a Python package.
1717

1818
:::{figure-md} packaging-outline
1919

20+
<<<<<<< HEAD
2021
<img src="../images/tutorials/packaging-101-outline.png" alt="Diagram showing the lessons in our packaging tutorial. There are 6 total - what is a Python package, make code pip installable, publish your package to PyPI, add a README and LICENSE file, add metadata for PyPI and finally publish to conda forge." width="800px">
22+
=======
23+
<img src="../images/tutorials/packaging-101-outline.png" alt="Diagram showing the lessons in our packaging tutorial. There are 6 total - what is a python package, make code pip installable, publish your package to PyPI, add a readme and license file, add metadata for pypi and finally publish to ." width="800px">
24+
>>>>>>> ae37574 (Fix: conda-forge fixes throughout)
2125
2226
This lesson is the first in a series of lessons to help you get started with Python packaging.
2327
:::
@@ -319,10 +323,10 @@ Then you can create a conda-forge recipe using the [Grayskull](https://github.co
319323

320324

321325
:::{figure-md} build-workflow-tutorial
322-
<img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testPyPI or the real PyPI. From PyPI you can then connect to conda forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
326+
<img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testPyPI or the real PyPI. From PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
323327

324328
In the image above, you can see the steps associated with publishing
325-
your package on PyPI and conda forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repo. You will learn more about this process in the [conda-forge lesson](#).
329+
your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repo. You will learn more about this process in the [conda-forge lesson](#).
326330
:::
327331

328332
## Yay, your package has users! Now what?

tutorials/publish-conda-forge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ for conda, conda-forge will build from your PyPI source distribution file (sdist
3434

3535
<img src="../images/publish-python-package-pypi-conda.png" alt="Image showing the progression of creating a Python package, building it and then publishing to PyPI and conda-forge. You take your code and turn it into distribution files (sdist and wheel) that PyPI accepts. then there is an arrow towards the PyPI repository where ou publish both distributions. From PyPI if you create a conda-forge recipe you can then publish to conda-forge. " width="700px">
3636

37-
Once you have published both package distributions (the source distribution and the wheel) to PyPI, you can then publish to conda-forge. Conda forge requires an source distribution on PyPI in order to build your package on conda-forge. You do not need to rebuild your package to publish to conda-forge.
37+
Once you have published both package distributions (the source distribution and the wheel) to PyPI, you can then publish to conda-forge. requires an source distribution on PyPI in order to build your package on conda-forge. You do not need to rebuild your package to publish to conda-forge.
3838
:::
3939

40-
## What is conda forge?
40+
## What is conda-forge?
4141
conda is an open source package and environment management tool that
4242
can be used to install tools from the different channels within the Anaconda Cloud repository.
4343

@@ -57,7 +57,7 @@ Make a graphic to replace that geohackweek graphic that is also more specific.
5757
Conda channels represent various repositories that you can install packages from. Because conda-forge is community maintained, anyone can submit a recipe there. PiPY is also a community maintained repository. Anyone can submit a package to PyPI and test PyPI. Unlike conda-forge there are no manual checks of packages submitted to PyPI.
5858
:::
5959

60-
## Why publish to conda forge
60+
## Why publish to conda-forge
6161

6262
There are many users, especially in the scientific Python ecosystem that use conda as their primary package manager / environment tool. Thus, having packages available to these users on the conda-forge channel is useful. In some cases packages on conda-forge can minimize dependency conflicts that can occur when mixing installations using pip and conda. This is particularly important for the spatial ecosystem.
6363

@@ -361,7 +361,7 @@ Once you have completed all of the above, you are ready to open up a pull reques
361361

362362
### Conda-forge Staged-recipes Pull Request Checklist
363363

364-
When you submit your package to conda forge, the pull request template includes a list of checks that you want to ensure you have covered.
364+
When you submit your package to conda-forge, the pull request template includes a list of checks that you want to ensure you have covered.
365365

366366
Below we break down each element of that list.
367367

tutorials/publish-pypi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You will learn how to publish to conda-forge in the [next lesson](7-publish-cond
4646
:::
4747

4848
:::{figure-md} build-workflow-tutorial
49-
<img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. An arrow to the right takes you to a build distribution files box. Another arrow to the right takes you to a publish to PyPI box which has an arrow containing sdist and wheel that notes those files go to PyPI for hosting. From PyPI is an arrow containing sdist since you can then connect to conda forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
49+
<img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. An arrow to the right takes you to a build distribution files box. Another arrow to the right takes you to a publish to PyPI box which has an arrow containing sdist and wheel that notes those files go to PyPI for hosting. From PyPI is an arrow containing sdist since you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
5050

5151
You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users.
5252
:::

0 commit comments

Comments
 (0)