diff --git a/_posts/2024-05-30-pyos-pyconus-2024-recap.md b/_posts/2024-05-30-pyos-pyconus-2024-recap.md index dbfc28cb..a9aa29d9 100644 --- a/_posts/2024-05-30-pyos-pyconus-2024-recap.md +++ b/_posts/2024-05-30-pyos-pyconus-2024-recap.md @@ -21,15 +21,14 @@ comments: true * fix captions * add stravalib note at the end of my talk section --> -
## TL;DR * pyOpenSci had a strong presence at [PyCon US](https://us.pycon.org/2024/) this year. I hope this continues for years to come! We held an open space, helped run the [Maintainers Summit](https://us.pycon.org/2024/events/maintainers-summit/) (lead by [Inessa Pawson](https://github.com/InessaPawson) for 5 years and counting), gave [a talk on Python packaging](https://us.pycon.org/2024/schedule/presentation/34/) and ran a 1 day sprint where over 16 people contributed to our efforts. * pyOpenSci’s theme this year for PyConUS was people first: people first when trying to make technical concepts easier to understand, people first when trying to write good tutorials or documentation and people first when you are trying to solve the world’s hardest problems. * Giving a talk on packaging at pyConUS triggered every ounce of the imposter in me. But in the end it was a rewarding experience. Having friends in the audience made a world of difference. It was calming to focus on people who I know support both me and this vibrant organization. Friends really should never let friends…package…or use Python…or do anything technical…alone. -
+ ## Another year, another incredible PyCon @@ -42,7 +41,6 @@ PyCon US, run by the [Python Software Foundation,](https://www.python.org/psf-landing/) is one of the biggest Python meetings in the world, with a record 2,700 registrations this year. {: .notice } - I also knew that I'd get to see a bunch of the friends who I met last year. I was returning to this inclusive community, filled with Pythonistas like me who care, who want to learn, and most importantly who want to help each other. @@ -73,7 +71,6 @@ projects and organizations and our sprints were awesome with many new contributi My takeaway: if you are considering going to PyCon but are worried about not knowing people YOU SHOULD STILL GO! You can feel the true spirit of open source (and open science) at PyCon US. No judgement. All "levels" of Pythonistas welcome. - ## My first main track PyCon US talk: Friends don't let friends package alone This year, I gave my first main track talk at PyCon, titled “Friends Don’t Let @@ -81,19 +78,23 @@ Friends Package Alone.” Getting a main track slot means presenting on a big stage to a huge room of people! It was real - headset mic, incredible tech support, and even an “escort” from the speaker room to the main stage. Wow! +You can check it out on youtube below: + +{% include video id="mJPoj9Ex9fk" provider="youtube" %} + Speaking of friends, it was my friends who got me through this talk. I saw them sitting in the front rows, smiling and supporting me. They both empowered me and gave me calm. As someone who often battles imposter syndrome, giving a talk on the "big" stage of a tech meeting was unforgettable. -
Image of a woman on a big stage wearing a red tank top talking. On the side is a slide that says pyOpenSci - Save the Date. Open science fall festival september 28-29 2024
Me talking on the stage! I was so nervous before but once I got up there, everything calmed in my mind. .
### A talk about making Python packaging more beginner friendly + My talk focused on how pyOpenSci helps beginners by breaking down complex packaging concepts into simple, digestible pieces. I leaned into decades of experience and study of teaching data science to various audiences, from big-ten university students @@ -110,22 +111,17 @@ fundamental concepts, and * avoid “Too Many Options and Opinions” (TMO) to keep things simple for beginners. - -
A cute image of a black flat coated retriever laying on the floor with a purple ice pack on it's head looking right at you.
Whether it's too many options or too many opinions, TMO will push beginner users away. Too many options create cognitive load that prevent users from having successful experiences.
- Giving a talk at PyConUS experience reinforced my belief in the power of community to tackle complex problems and support each other in our scientific journeys. - - - ## The PyCon US maintainers Summit This year, I had the honor of helping [Inessa Pawson](https://github.com/InessaPawson) and [Kara Sowles](https://github.com/karasowles) organize the @@ -160,7 +155,6 @@ quickly and a waitlist, the event was a success. Next year (if we are invited ba {% include video id="L-Ok_89QJOM" provider="youtube" %} - Also if you were wondering, yes that Monstera Deliciosa (plant) in the background is real! AND YES it is ginormous! ## Our second pyOpenSci sprint @@ -173,11 +167,9 @@ This year we had a tremendous turnout of over 20 people from several countries f
The pyConUS sprint sign-up board had lots of projects. Because the rooms are large, projects tend to share spaces. We ended up in the packaging room which was great as it allowed us to do some more difficult work around Python packages with C extensions!
- - If you haven’t been to a sprint before, it’s an experience that every open source enthusiast should have. Sprints are where a bunch of people come together to work on a project. If you are running sprints that support software development in a professional environment (i.e. at a company) this might mean a team of people working together on releasing a new software feature. But for the open source community, sprints can also mean volunteers coming to a space to help maintainers work on various parts of a project that they care about - like pyOpenSci! -pyOpenSci supports other people's software through it's [open community-lead peer review process ](https://www.pyopensci.org/about-peer-review/index.html) and it's online, free [packaging resources](https://www.pyopensci.org/python-package-guide/). But it also has it's own software too. We have tools that help us keep track of our review process and volunteer contributions so we can acknowledge everyone for their effort. +pyOpenSci supports other people's software through it's [open community-lead peer review process](https://www.pyopensci.org/about-peer-review/index.html) and it's online, free [packaging resources](https://www.pyopensci.org/python-package-guide/). But it also has it's own software too. We have tools that help us keep track of our review process and volunteer contributions so we can acknowledge everyone for their effort. Acknowledging contributions is so so so (did I mention SO?) important. And we value them so much. @@ -225,8 +217,8 @@ workflows that allow allowing scientists to focus on their research rather than tools. We plan to tackle some of these and other topics during our Fall festival on September 28-29, 2024 so save the date and come ready to learn and share! - ## Packaging summit + Last but not least, pyOpenSci had a strong presence at the PyConUS packaging summit this year. The summit was organization by [Pradyun Gedam](https://github.com/pradyunsg), [Jannis Leidel](https://github.com/jezdez), [CAM Gerlach](https://github.com/CAM-Gerlach), [Filipe Laínes](https://github.com/FFY00). As I have mentioned several times, packaging is one of the more thorny topics in our Python ecosystem. However, this year, things felt different compared to last. For one, there were a lot more people in the room, and people with different perspectives. For starters, last year I was 1 of 3? female-identifying people in the room - this year there were people from many backgrounds and identities in the room! Last year also felt more technical whereas this year was a perfect mix of discussing technical topics combined with a strong theme of considering user experience in both installing Python and creating packages. PLUS - documentation - yes PLEASE! @@ -237,7 +229,7 @@ I'm hopeful. From my perspective, the biggest challenges in our ecosystem revolve around: -* too much focus on tools and not enough focus on user experience and documentation, and +* too much focus on tools and not enough focus on user experience and documentation, and * too many options and opinions that prevent users from have early success. There is a path forward. And people who are working on tools in the ecosystem really do care -- a lot. So please thank them - thank the maintainers and people who work on the tools that you use - or might use in the future. It's all volunteer time. diff --git a/_posts/2024-06-25-create-your-first-python-package-scipy-2024.md b/_posts/2024-06-25-create-your-first-python-package-scipy-2024.md new file mode 100644 index 00000000..a98f85a5 --- /dev/null +++ b/_posts/2024-06-25-create-your-first-python-package-scipy-2024.md @@ -0,0 +1,274 @@ +--- +layout: single +title: "pyOpenSci Workshop: Create Your First Python Package" +excerpt: "pyOpenSci will be running our `Create Your First Python Package: Make Your Python Code Easier to Share and Use +` workshop at SciPy 2024. Read on to learn more!" +author: "Jesse Mostipak" +permalink: /blog/pyos-workshop-scipy-2024.html +header: + overlay_image: images/headers/scipy-2024-workshop.png + overlay_filter: rgba(20, 13, 36, 0.8) +categories: + - blog-post + - community + - events +classes: wide +toc: true +comments: true +--- +## Create Your First Python Package: Make Your Python Code Easier to Share and Use + +* **What:** A hands-on workshop, titled: [Create Your First Python Package: Make Your Python Code Easier to Share and Use](https://cfp.scipy.org/2024/talk/QT9GBY/) +* **Where:** [SciPy 2024](https://www.scipy2024.scipy.org/), Room 316 +* **When:** Tuesday, July 9th, 2024, from 13:30--17:30 Pacific +* **Workshop GitHub repository:** [https://github.com/pyOpenSci/code-to-module-workshop/](https://github.com/pyOpenSci/code-to-module-workshop/) +* **pyOpenSci demo package:** [https://github.com/pyOpenSci/pyosPackage](https://github.com/pyOpenSci/pyosPackage) + +## Event overview + +Creating code that can be shared and reused is the gold-standard of open science. But the tools and skills to share your code can be tricky to learn. In this hands-on tutorial, you’ll learn how to turn your code into an installable Python module (a file containing Python code that defines functions, classes, and variables), that can be shared with others. We will provide pre-built code and module examples for each step of the tutorial to help make it more beginner-friendly, but you will need some basic Python skills to get the most out of this session. + +You will leave this tutorial understanding how to: +* Create code that can be installed into different environments +* Use [Hatch](https://hatch.pypa.io/latest/) as a workflow tool, making setup and installation of your code easier +* Use Hatch to publish your package to the test version of [PyPI](https://pypi.org/) + +## What you need to know +* Basic Python programming +* How to write functions in Python +* How to use a Python environment manager of your choosing + +## What you need installed +* Python +* An environment manager +* Hatch + +## Workshop agenda + + + + + + + + + + + + + + + + + + + + +
Hour one: The structure of an installable module.
Key takeaways
    +
  • The purpose of the __init__.py file
    • +
  • How workflow tools such as Hatch can be useful when making code installable.
    • +
Breakdown
0-15 minutes: Here we will get to know each other. I’ll also briefly introduce pyOpenSci and the work that we are doing in open science education and training space.
15-30 minutes, interactive discussion: Here, we’ll discuss why shareable code is important. And we’ll explore some best practices for making code easier to work with. I’ll also introduce Hatch as a workflow tool that streamlines tasks.
30-60 minutes, hands-on: You will take an existing script and turn it into an installable module. You are welcome to use the provided scripts for this. If you are more comfortable with Python, then you can also bring your own script with you and work on it during the workshop.
+
+ + + + + + + + + + + + + + + + + +
Hour two: Everything you need to know about the pyproject.toml file & project metadata.
Breakdown
0-15 minutes, interactive discussion: Here you’ll learn about the pyproject.toml and how it’s used to document dependencies, and metadata for your project.
15-30 minutes: A short break to stretch your legs and get a drink.
30-60 minutes, hands-on: In the hands-on part of this hour, you will modify your pyproject.toml file with required dependencies needed to run your code. You will also learn how to install your code in interactive or development mode using both pip and Hatch. Interactive mode will allow you to dynamically update your code and test it locally without reinstalling it. Finally, you will take your shiny new Python module for a test drive in your favorite Python environment.
+
+ + + + + + + + + + + + + + + + + +
Hour three: The power of metadata and instructions for you, your future self & your colleagues.
Breakdown
0-15 minutes, interactive discussion: In this part of the tutorial we’ll discuss the power of documentation when sharing code and also for you when you have to update things in the future.
15-50 minutes, hands-on: Here you will create a README file that helps users of your module understand how to install it and how to get started using it. You will also add docstrings to your code. See how docstrings are useful as “hints” when coding real time. Optional: if you are speedy, you can also delve into typing your code on your own. However, we won’t directly cover typing in this tutorial.
50-60 minutes: Break
+
+ + + + + + + + + + + + + + + + + +
Hour four: Publishing and sharing your code.
Breakdown
0-15 minutes, interactive discussion: Here we will discuss what it means to “publish” code. We will also discuss other important elements such as license files and codes of conduct if you intend to turn your code into a published package.
15-45 minutes, hands-on: Publishing to PyPI vs. installing from Github. Those who’d like to follow along interactively can do so here. However, if your brain is tired, sit back and learn how to build your module into a package distribution using Hatch. And then we will give you all of the tools needed to publish to the test version of PyPI.
45-60 minutes: Wrap up, answer any questions, and provide feedback on the session.
+ +## Hatch & Python + +If you already have a working version of Python on your computer, then you are in good shape!**If you don’t have Python installed on your computer, then Hatch will install Python for you when you install it following the instructions below.** + +## Install Hatch + +_These instructions were adapted from the [Introduction to hatch](https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html) section of the [pyOpenSci Python Packaging Guide](https://www.pyopensci.org/python-package-guide/)._ + +### For Mac users + +_These instructions are for installing Hatch using the GUI installer. If you’d prefer to use the Command line installer, please see the [Hatch documentation](https://hatch.pypa.io/latest/install/#command-line-installer)._ + +1. In your browser, download the `.pkg` file: [hatch-universal.pkg](https://github.com/pypa/hatch/releases/latest/download/hatch-universal.pkg) +2. Run the downloaded file and follow the on-screen instructions to install Hatch. +3. Restart your terminal if it is already open. +4. To verify that shell can find and run the `hatch` command, run: + 1. `hatch --version` (in your Terminal / shell). + +### For Linux users + +_For linux users, the easiest way to install Hatch is to use pipx which can be installed using apt install. Note: if you prefer to use a tool other than pipx, please refer to the [Hatch documentation](https://hatch.pypa.io/latest/) for more information_ + +* Install hatch from the command line using [pipx](https://pipx.pypa.io/stable/): + +```bash +# First install pipx using apt install +>> apt install pipx +# Then use pipx to install hatch +>> pipx install hatch +``` + +### For Windows users + +_These instructions are for installing Hatch using the GUI installer. If you’d prefer to use the Command line installer, please see the [Hatch documentation](https://hatch.pypa.io/latest/install/#command-line-installer_1)._ + +1. In your browser, download the `.msi` file: [hatch-x64.msi](https://github.com/pypa/hatch/releases/latest/download/hatch-x64.msi) +2. Run your downloaded file and follow the on-screen instructions. +3. Restart your terminal if it was already open. +4. To verify that the shell can find and run the `hatch` command in your `PATH`, in your terminal run: + 1. `hatch --version` + +### Configure Hatch (all systems) + +After installing Hatch, it’s useful to customize the Hatch configuration. The +configuration allows you to specify things like the default name and email to +use in your package’s metadata. If you don’t configure Hatch, you can always +edit files later! However your Hatch package outputs might look a bit different +than the ones in the workshop. (This is ok!) + +Hatch stores your configuration information in a `config.toml` file. + +While you can update the `config.toml` file through the command line, it might +be easier to look at it and update it in a text editor if you are using it for +the first time. + +1. Open and edit your `config.toml` file by either: + 1. Running `hatch config explore` in your shell, which will open up a directory window that will allow you to double click on the file and open it in your favorite text editor. + 2. Alternatively, you can retrieve the location of the Hatch config file by running `hatch config find` in your shell. +2. Update your email and name + 3. Once the file is open, update the [template] table of the `config.toml` file with your name and email. This information will be used in any `pyproject.toml` metadata files that you create using Hatch. +3. Set tests to `false` + + _While tests are important, setting the tests configuration in Hatch to true will create a more complex pyproject.toml file. We won’t be creating tests in this workshop._ + + Set tests to `false` in the `[template.plugins.default]` table. + +Your config file should look something like this: + +```toml +mode = "local" +project = "" +shell = "" + +[dirs] +project = [] +python = "isolated" +data = "/Users/leahawasser/Library/Application Support/hatch" +cache = "/Users/leahawasser/Library/Caches/hatch" + +[dirs.env] + +[projects] + +[publish.index] +repo = "main" + +[template] +name = "Leah Wasser" +email = "leah@pyopensci.org" + +[template.licenses] +headers = true +default = [ + "MIT", +] + +[template.plugins.default] +tests = false +ci = false +src-layout = true + +[terminal.styles] +info = "bold" +success = "bold cyan" +error = "bold red" +warning = "bold yellow" +waiting = "bold magenta" +debug = "bold" +spinner = "simpleDotsScrolling" +``` + +Note: for future packages you may want to enable both CI and tests. This +configuration is to simplify things for our beginner-friendly tutorial. + +4. Close the config file and run `hatch config show` + + `hatch config show` + +This command prints out the contents of your config.toml file in your shell. +Look at the values and ensure that your name and email are set and also make +sure that `tests=false`. + +## Useful Commands + +### Conda environments + +* **Create environment:** `conda create -n env_name python=3.11` +* **Activate environment:** `conda activate env_name` +* **Leave environment:** `conda deactivate` + +### Venv environments + +Create environment + +* `python -m venv env_name` +* Activate_windows: `env_name\Scripts\activate` +* Activate MAC / LINUX: `source env_name/bin/activate` +* Leave environment: `deactivate` + +## Helpful links +* Our [example Python package repo, `pyosPackage`](https://github.com/pyOpenSci/pyosPackage), that goes along with pyOpenSci tutorials. +* [Workshop information on the SciPy 2024 website](https://cfp.scipy.org/2024/talk/QT9GBY/). + +## Connect with pyOpenSci + +Stay up-to-date with all things pyOpenSci by following us on [LinkedIn](https://linkedin.com/company/pyopensci) and [Fosstodon](https://fosstodon.org/@pyOpenSci), and connect with the broader pyOpenSci community on our [Discourse forum](https://pyopensci.discourse.group/). If you’re interested in our weekly newsletter where we share news, blog posts, and monthly updates, [subscribe on LinkedIn](https://www.bit.ly/pyOSNewsletter). diff --git a/_sass/minimal-mistakes/_pyos-dropdown.scss b/_sass/minimal-mistakes/_pyos-dropdown.scss index 278b71fe..9fb94a75 100644 --- a/_sass/minimal-mistakes/_pyos-dropdown.scss +++ b/_sass/minimal-mistakes/_pyos-dropdown.scss @@ -349,8 +349,8 @@ drop shadow /* Positioned by burger TODO: might be better within the drop down??*/ .search__toggle { - position: fixed; - right: 20%; + position: absolute; + right: -6%; font-size: 1.4em; top: 3%; } diff --git a/_sass/minimal-mistakes/_pyos-main.scss b/_sass/minimal-mistakes/_pyos-main.scss index a39f0174..72ae9f26 100644 --- a/_sass/minimal-mistakes/_pyos-main.scss +++ b/_sass/minimal-mistakes/_pyos-main.scss @@ -188,7 +188,7 @@ h2.clearall { max-width: 90%!important; } ol { - font-size: 1.3em; + font-size: 1em; } } diff --git a/images/headers/scipy-2024-workshop.png b/images/headers/scipy-2024-workshop.png new file mode 100644 index 00000000..c2d3c32f Binary files /dev/null and b/images/headers/scipy-2024-workshop.png differ