Skip to content

Commit 3c47a61

Browse files
authored
Update README
1 parent cb0637d commit 3c47a61

1 file changed

Lines changed: 4 additions & 37 deletions

File tree

README.md

Lines changed: 4 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -10,44 +10,11 @@ Maintaining code quality can be challenging, no matter the size of your project
1010

1111
Pre-commit hooks are code checks that run whenever you attempt to commit your changes with `git`. They can detect and, in some cases, automatically correct code-quality issues *before* they make it to your code base. In this tutorial, you will learn how to install and configure pre-commit hooks for your repository to ensure that only code that passes your checks makes it into your code base. We will also explore how to build custom pre-commit hooks for novel use cases.
1212

13-
## Setup Instructions
14-
15-
1. Fork and clone this repository. If you don't have a GitHub account, you will need to create one to complete this step. Please be sure to check for changes (and sync them) before coming to the workshop.
16-
17-
2. Create a virtual environment using Python 3.10 or higher on your personal laptop, and install `pre-commit` in that virtual environment. You can use the tool of your choice (*e.g.*, `venv`, `conda`, `uv`), but do not attempt to install the project itself.
18-
19-
<details>
20-
<summary>Using <code>venv</code></summary>
21-
22-
On Linux or MacOS:
23-
24-
```shell
25-
python -m venv venv
26-
source venv/bin/activate
27-
python -m pip install -U pip # please make sure you have pip>=25.1
28-
python -m pip install pre-commit
29-
```
30-
31-
See https://docs.python.org/3/library/venv.html for more information and the Windows equivalent if you decide to use `venv`.
32-
33-
</details>
34-
35-
<details>
36-
<summary>Using <code>uv</code></summary>
37-
38-
Note that this will install `pre-commit` as a tool for global use:
39-
40-
```shell
41-
uv python install # install the Python version in .python-version, if not already installed
42-
uv tool install pre-commit --with pre-commit-uv
43-
```
44-
45-
</details>
46-
47-
3. Think about some potential ideas for the pre-commit hook you would like to create in the second half of the workshop. Some ideas to get you started: prohibit `print()` calls, enforce file naming conventions, block large files, keep files under a certain number of lines, check for missing docstrings, disallow certain imports, *etc.*
48-
49-
5013
## About the Author
14+
[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/stefmolin&style=flat)](https://github.com/sponsors/stefmolin)
15+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-yellow?style=flat&logo=buymeacoffee&logoColor=white&labelColor=yellow&color=gray)
16+
](https://www.buymeacoffee.com/stefanie.molin)
17+
[![Ko-Fi](https://shields.io/badge/kofi-Support-ff5f5f?logo=ko-fi&style=flat)](https://ko-fi.com/stefaniemolin)
5118

5219
[Stefanie Molin](https://stefaniemolin.com) ([@stefmolin](https://github.com/stefmolin)) is a software engineer at Bloomberg in New York City, where she tackles tough problems in information security, particularly those revolving around data wrangling/visualization, building tools for gathering data, and knowledge sharing. She is also a core developer of [numpydoc](https://github.com/numpy/numpydoc) and the author of [Hands-On Data Analysis with Pandas](https://www.amazon.com/dp/1800563450/), which is currently in its second edition and has been translated into Korean and Chinese. She holds a bachelor’s of science degree in operations research from Columbia University's Fu Foundation School of Engineering and Applied Science, as well as a master’s degree in computer science, with a specialization in machine learning, from Georgia Tech. In her free time, she enjoys traveling the world, inventing new recipes, and learning new languages spoken among both people and computers.
5320

0 commit comments

Comments
 (0)