Skip to content

Commit c2c27ce

Browse files
Diparnanathanjmcdougall
Diparna
and
nathanjmcdougall
authored
Added Emojis! (#473)
* Added Emojis! * Update README.md Remove some potentially excessive emoji * Update README.md Tweaks to emoji --------- Co-authored-by: Nathan McDougall <nathan.j.mcdougall@gmail.com>
1 parent c5afae3 commit c2c27ce

1 file changed

Lines changed: 14 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://raw.githubusercontent.com/nathanjmcdougall/usethis-python/refs/heads/main/docs/logo.svg"><br>
33
</h1>
44

5-
# usethis
5+
# usethis 🐍
66

77
[![usethis](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/nathanjmcdougall/usethis-python/main/assets/badge/v1.json)](https://github.com/nathanjmcdougall/usethis-python)
88
[![PyPI Version](https://img.shields.io/pypi/v/usethis.svg)](https://pypi.python.org/pypi/usethis)
@@ -15,28 +15,24 @@
1515

1616
Automate Python project setup and development tasks that are otherwise performed manually.
1717

18-
usethis knows about popular Python tools, workflows and frameworks, and knows how they
19-
interact. It can add and remove tools, configure them, and set up the project for you
20-
in a way that won't break your existing configuration and it will make the necessary
21-
adjustments to your project configuration files.
18+
`usethis` knows about popular Python tools, workflows and frameworks, and knows how they interact. It can add and remove tools, configure them, and set up the project for you in a way that won't break your existing configuration and it will make the necessary adjustments to your project configuration files.
2219

23-
usethis gives detailed messages about what it is doing (and what you need to do next).
20+
`usethis` gives detailed messages about what it is doing (and what you need to do next).
2421

2522
- Output beginning with `✔` represents a task which usethis has automated.
2623
- Output beginning with `☐` represents a task which you need to perform manually.
2724
- Output beginning with `ℹ` gives hints and tips.
2825

29-
Inspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html),
30-
this package brings a similar experience to the Python ecosystem as a CLI tool.
26+
Inspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html), this package brings a similar experience to the Python ecosystem as a CLI tool.
3127

3228
## Highlights
3329

34-
- First-class support for state-of-the-practice tooling: `uv`, `ruff`, `pytest`, `pre-commit`, and many more.
35-
- Automatically add and remove tools: declare, install, and configure in one step.
36-
- Powerful knowledge of how different tools interact and sensible defaults.
37-
- Get started on a new Python project or a new workflow in seconds.
30+
- 🧰 First-class support for state-of-the-practice tooling: `uv`, `ruff`, `pytest`, `pre-commit`, and many more.
31+
- 🤖 Automatically add and remove tools: declare, install, and configure in one step.
32+
- 🧠 Powerful knowledge of how different tools interact and sensible defaults.
33+
- ⚡ Get started on a new Python project or a new workflow in seconds.
3834

39-
## Getting Started
35+
## 🧭 Getting Started
4036

4137
First, it is strongly recommended you [install the `uv` package manager](https://docs.astral.sh/uv/getting-started/installation/): this is a simple, documented process. If you're already using `uv`, make sure you're using at least
4238
version v0.5.29 (run `uv version` to check, and `uv self update` to upgrade).
@@ -53,7 +49,7 @@ $ pip install usethis
5349

5450
Alternatively, run in isolation, using `uvx` or `pipx`.
5551

56-
## Command Line Interface
52+
## 🖥️ Command Line Interface
5753

5854
### Main commands
5955

@@ -73,7 +69,7 @@ Alternatively, run in isolation, using `uvx` or `pipx`.
7369
- [`usethis show`](#usethis-show)
7470
- [`usethis browse pypi`](#usethis-browse-pypi-package)
7571

76-
## Example Usage
72+
## 💡 Example Usage
7773

7874
To use Ruff on a fresh project, run:
7975

@@ -113,7 +109,7 @@ $ uvx usethis ci bitbucket
113109
☐ Run your pipeline via the Bitbucket website.
114110
```
115111

116-
## Command Reference
112+
## 🖥️ Command Reference
117113

118114
### `usethis tool`
119115

@@ -238,14 +234,10 @@ Supported options:
238234

239235
## Development
240236

241-
This project is at the early stages of development. If you are interested in contributing,
242-
please ensure you have a corresponding GitHub Issue open.
237+
This project is at the early stages of development. If you are interested in contributing, please ensure you have a corresponding GitHub Issue open.
243238

244239
## License
245240

246241
usethis is licensed under the MIT license ([LICENSE](https://github.com/nathanjmcdougall/usethis-python/blob/main/LICENSE) or <https://opensource.org/licenses/MIT>)
247242

248-
Unless you explicitly state otherwise, any contribution intentionally submitted for
249-
inclusion in usethis by you, as defined in the Apache License, Version 2.0,
250-
(<https://www.apache.org/licenses/LICENSE-2.0>), shall be licensed under the
251-
MIT license, without any additional terms or conditions.
243+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in usethis by you, as defined in the Apache License, Version 2.0, (<https://www.apache.org/licenses/LICENSE-2.0>), shall be licensed under the MIT license, without any additional terms or conditions.

0 commit comments

Comments
 (0)