Skip to content

Commit 6adeb38

Browse files
committed
chore: general fixes to grammar, spelling, etc. in the README.md
1 parent 77ac9ee commit 6adeb38

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
A Python project template robust enough to follow up [cookiecutter-hypermodern-python]
44

55
# Caveat
6-
I really believe this idea has a lot of good ideas and best practices, however creating it is a ton of work.
6+
I really believe this idea has a lot of good ideas and best practices, however, creating it is a ton of work.
77

88
There is definitely a lot left to do before this project is truly a daily driver, but I think there are just a few more pieces missing from this being at least useful in many cases.
99

10-
If you have any interest in this project please don't hesitate to reach out!
11-
Any and all advice, support, PR's, etc are welcome and would be greatly appreciated.
10+
If you have any interest in this project, please don't hesitate to reach out!
11+
Any advice, support, PR's, etc. are welcome and would be greatly appreciated.
1212

1313

1414
# Why does this project exist?
1515
Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.
1616
While it will always have a place in my heart, there have been far too many improvements in Python tooling to keep using it as is.
1717

18-
For a while I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however when it came time to switch
19-
to new tooling such as [ruff], [uv], [maturin], etc, I found the process of updating the existing tooling to be extremly painful.
18+
For a while I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however, when it came time to switch
19+
to new tooling such as [ruff], [uv], [maturin], etc., I found the process of updating the existing tooling to be extremely painful.
2020

21-
The [Hypermodern Python Cookiecutter] remains as a fantastic sendoff point for devs interested in building a 2021 style Python Package, but there were
22-
a handfull of issues with it that prevented it from being able to adapt to new Python developments over the years.
21+
The [Hypermodern Python Cookiecutter] remains as a fantastic sendoff point for devs interested in building a 2021-style Python Package. However, there were
22+
a handful of issues with it that prevented it from being able to adapt to new Python developments over the years.
2323

2424
# Okay, so what's different this time?
2525
The [Robust Python Cookiecutter] exists to solve a few main concerns
@@ -30,7 +30,7 @@ The [Robust Python Cookiecutter] exists to solve a few main concerns
3030
- [Project Neglect](#project-neglect)
3131

3232

33-
## Template Update Propogation
33+
## Template Update Propagation
3434
One of the main issues I encountered with [my personal fork] of the [Hypermodern Python Cookiecutter] was that any change
3535
I made to my repos would mean a later conflict if I tried to rerun [cookiecutter] to sync a change from a different project.
3636

@@ -42,9 +42,9 @@ in the pyproject.toml.
4242

4343

4444
## Project Domain Expansion
45-
Now, I'm not one to advocate for mixing languages together in a project. However, there is a really unique case that has arisen with the creation of [maturin].
45+
Now, I'm not one to advocate for mixing languages in a project. However, there is a unique case that has arisen with the creation of [maturin].
4646

47-
There are a plethora of great projects such as [ruff], [uv], [polars], [just], etc all making use of [maturin] to get the performance improvements of [rust] while
47+
There are a plethora of great projects such as [ruff], [uv], [polars], [just], etc. all making use of [maturin] to get the performance improvements of [rust] while
4848
submitting their package to both pypi and crates.io
4949

5050
Now, this definitely is not required by any means to make a good Python package, however this pattern only seems to be picking up momentum and has honestly been a massive boon
@@ -60,9 +60,6 @@ Additionally, the [Robust Python Cookiecutter] is designed with both normal and
6060
a quick [rust] module for performance or you are trying to publish a series of crates and packages, either case will be handled using a setup inspired by [polars].
6161

6262

63-
64-
65-
6663
## Documenting Tooling Decisions
6764
One of the really stand out features of the [Hypermodern Python Cookiecutter] was its incredibly detailed documentation.
6865
It did a pretty great job of describing the tooling to use, but there was a distinct lack of ***why*** these decisions were made.
@@ -72,11 +69,11 @@ It may seem like a small detail, but detailing why a decision was made has an in
7269
Rather than having to go through a mini crusade to determine whether we use [poetry] or [uv], we can just point to the
7370
[existing reasoning](https://cookiecutter-robust-python.readthedocs.io/en/latest/topics/02_dependency_management.md#option-2--term--poetry) to see if it still is true or not.
7471

75-
Overall it's rather rare that people debate over tooling for no reason. Most things have merit in some cases, and a large goal of this template is identifying the tools that have the most merit in almost all cases.
72+
Overall, it's rather rare that people debate over tooling for no reason. Most things have merit in some cases, and a large goal of this template is identifying the tools that have the most merit in almost all cases.
7673

7774
## CI/CD Vendor Lock
7875
Now don't get me wrong, I love [github-actions] and do pretty much everything in my power to avoid [bitbucket-pipelines].
79-
However, not all jobs have the luxury of github, and I would love to be able to just use the same template for both my personal and professional projects.
76+
However, not all jobs have the luxury of GitHub, and I would love to be able to just use the same template for both my personal and professional projects.
8077

8178
The [Robust Python Cookiecutter] focuses on being as modular as possible for areas that connect to the CI/CD pipeline. Additionally, there will always be either alternative
8279
CI/CD options or at a minimum basic examples of what the translated CI/CD pipeline would look like.
@@ -94,7 +91,7 @@ implementing best practices in their python packages.
9491

9592
However, Open Source work is draining, and is especially so for a project template including metacode.
9693

97-
I can guarantee that if the [Robust Python Cookiecutter] ever sees any amount of users I will immediately transfer it to an organization to enable at least a handful
94+
I can guarantee that if the [Robust Python Cookiecutter] ever sees any number of users, I will immediately transfer it to an organization to enable at least a handful
9895
of trusted individuals to ensure the project is taken care of.
9996

10097
[bitbucket-pipelines]: https://support.atlassian.com/bitbucket-cloud/docs/write-a-pipe-for-bitbucket-pipelines/

0 commit comments

Comments
 (0)