Skip to content

Commit b58af4b

Browse files
authored
Cleanup the README by fixing various typos and improving formatting. (#80)
1 parent 65156bd commit b58af4b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,32 @@
1111
the official Roboflow python package that interfaces with the [Roboflow API](https://docs.roboflow.com). Key features of
1212
Roboflow:
1313

14-
- Import and Export image datasets into any supported [formats](https://roboflow.com/formats)
14+
- Import and Export image datasets into any supported [format](https://roboflow.com/formats)
1515
- [Preprocess](https://docs.roboflow.com/image-transformations/image-preprocessing)
1616
and [augment](https://docs.roboflow.com/image-transformations/image-augmentation) data using Roboflow's dataset
1717
management tools
1818
- Train computer vision models using [Roboflow Train](https://docs.roboflow.com/train) and deploy
1919
to [production](https://docs.roboflow.com/inference)
2020
- Use [community curated projects](https://universe.roboflow.com/) to start building your own vision-powered products
2121

22-
## Installation:
22+
## Installation
2323

2424
To install this package, please use `Python 3.6` or higher. We provide three different ways to install the Roboflow
2525
package to use within your own projects.
2626

2727
Install from PyPi (Recommended):
2828

29-
```
29+
```bash
3030
pip install roboflow
3131
```
3232

3333
Install from Source:
3434

35-
```
35+
```bash
3636
git clone https://github.com/roboflow-ai/roboflow-python.git
3737
cd roboflow-python
3838
python3 -m venv env
39-
source env/bin/activate
39+
source env/bin/activate
4040
pip3 install -r requirements.txt
4141
```
4242

@@ -51,7 +51,7 @@ rf = roboflow.Roboflow(api_key=YOUR_API_KEY_HERE)
5151
# List all projects for your workspace
5252
workspace = rf.workspace()
5353

54-
# Load a certain project, workspace url is optional
54+
# Load a certain project (workspace url is optional)
5555
project = rf.project("PROJECT_ID")
5656

5757
# List all versions of a specific project
@@ -79,9 +79,9 @@ prediction.json()
7979
prediction.save(output_path='predictions.jpg')
8080
```
8181

82-
## Using this package for a specifc project
82+
## Using this package for a specific project
8383

84-
If you have a specific project from your workspace you'd like to run in a notebook follow along on this tutorial [Downloading Datasets from Roboflow for Training (Python)](https://www.youtube.com/watch?v=76E6esnez8E)
84+
If you have a specific project from your workspace you'd like to run in a notebook, follow along with this tutorial: [Downloading Datasets from Roboflow for Training (Python)](https://www.youtube.com/watch?v=76E6esnez8E).
8585

8686
Selecting the format you'd like your project to be exported as while choosing the `show download code` option will display code snippets you can use in either Jupyter or your terminal. These code snippets will include your `api_key`, project, and workspace names.
8787

@@ -107,7 +107,7 @@ docker build -t roboflow-python -f Dockerfile.dev .
107107
docker run --rm -it \
108108
-v $(pwd)/:/workspace/ \
109109
--env-file .env \
110-
roboflow-python
110+
roboflow-python
111111

112112
# Run tests
113113
python -m unittest
@@ -117,15 +117,13 @@ python -m unittest
117117

118118
You can pass the build arg `PYTHON_VERSION` to dynamically change python version at build time
119119

120-
```
120+
```bash
121121
docker build -t roboflow-python --build-arg PYTHON_VERSION=3.9 -f Dockerfile.dev .
122122
```
123123

124124
Will use `python:3.9-slim`
125125

126-
**Note** If you are using [VSCode](https://code.visualstudio.com/) we reccomend to read the ["Developing inside a Container"](https://code.visualstudio.com/docs/remote/containers) tutorial.
127-
128-
126+
**Note** If you are using [VSCode](https://code.visualstudio.com/) we recommend you read the ["Developing inside a Container"](https://code.visualstudio.com/docs/remote/containers) tutorial.
129127

130128
### Using Virtualenv
131129

@@ -161,7 +159,8 @@ python -m unittest
161159
### Code Quality
162160

163161
When creating new functions, please follow the [Google style Python docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). See example below:
164-
```
162+
163+
```python
165164
def example_function(param1: int, param2: str) -> bool:
166165
"""Example function that does something.
167166
@@ -177,9 +176,10 @@ def example_function(param1: int, param2: str) -> bool:
177176

178177
We provide a `Makefile` to format and ensure code quality. **Be sure to run them before creating a PR**.
179178

180-
```
181-
# format your code with `black` and `isort` run
179+
```bash
180+
# format code with `black` and `isort`
182181
make style
182+
183183
# check code with flake8
184184
make check_code_quality
185185
```

0 commit comments

Comments
 (0)