Skip to content

Commit 868ed36

Browse files
authored
Fix of grammatical errors (#148)
1 parent f393161 commit 868ed36

13 files changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ python3 -m pip install .
3535
python3 -m fastapi_template
3636
```
3737

38-
Also you can use it with docker.
38+
Also, you can use it with docker.
3939
```bash
4040
docker run --rm -it -v "$(pwd):/projects" s3rius/fastapi_template
4141
```

fastapi_template/template/{{cookiecutter.project_name}}/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,14 @@ This application can be configured with environment variables.
7373
You can create `.env` file in the root directory and place all
7474
environment variables here.
7575
76-
All environment variabels should start with "{{cookiecutter.project_name | upper}}_" prefix.
76+
All environment variables should start with "{{cookiecutter.project_name | upper}}_" prefix.
7777
7878
For example if you see in your "{{cookiecutter.project_name}}/settings.py" a variable named like
7979
`random_parameter`, you should provide the "{{cookiecutter.project_name | upper}}_RANDOM_PARAMETER"
8080
variable to configure the value. This behaviour can be changed by overriding `env_prefix` property
8181
in `{{cookiecutter.project_name}}.settings.Settings.Config`.
8282
83-
An exmaple of .env file:
83+
An example of .env file:
8484
```bash
8585
{{cookiecutter.project_name | upper}}_RELOAD="True"
8686
{{cookiecutter.project_name | upper}}_PORT="8000"
@@ -156,7 +156,7 @@ docker save --output {{cookiecutter.project_name}}.tar {{cookiecutter.project_na
156156
If you want to migrate your database, you should run following commands:
157157
```bash
158158
{%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
159-
# To run all migrations untill the migration with revision_id.
159+
# To run all migrations until the migration with revision_id.
160160
alembic upgrade "<revision_id>"
161161
162162
# To perform all pending migrations.
@@ -168,7 +168,7 @@ aerich upgrade
168168
{%- elif cookiecutter.orm == 'piccolo' %}
169169
# You have to set a PICCOLO_CONF variable
170170
export PICCOLO_CONF="{{cookiecutter.project_name}}.piccolo_conf"
171-
# Now you can easily run migrations usuing
171+
# Now you can easily run migrations using
172172
piccolo migrations forwards all
173173
{%- endif %}
174174
```

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/conftest.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ async def test_exchange_name() -> str:
354354
@pytest.fixture
355355
async def test_routing_key() -> str:
356356
"""
357-
Name of routing key to use whild binding test queue.
357+
Name of routing key to use while binding test queue.
358358
359359
:return: key string.
360360
"""
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"""Alembic migraions."""
1+
"""Alembic migrations."""

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/db_ormar/utils.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
{% if cookiecutter.db_info.name == "postgresql" -%}
88
def create_database() -> None:
9-
"""Create a databse."""
9+
"""Create a database."""
1010
db_url = make_url(str(settings.db_url.with_path('/postgres')))
1111
engine = create_engine(db_url, isolation_level="AUTOCOMMIT")
1212

@@ -46,7 +46,7 @@ def drop_database() -> None:
4646
{%- endif %}
4747
{%- if cookiecutter.db_info.name == "mysql" %}
4848
def create_database() -> None:
49-
"""Create a databse."""
49+
"""Create a database."""
5050
engine = create_engine(str(settings.db_url.with_path("/mysql")))
5151

5252
with engine.connect() as conn:
@@ -76,7 +76,7 @@ def drop_database() -> None:
7676
{%- endif %}
7777
{%- if cookiecutter.db_info.name == "sqlite" %}
7878
def create_database() -> None:
79-
"""Create a databse."""
79+
"""Create a database."""
8080

8181
def drop_database() -> None:
8282
"""Drop current database."""
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"""Alembic migraions."""
1+
"""Alembic migrations."""

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/db_sa/utils.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
{% if cookiecutter.db_info.name == "postgresql" -%}
99
async def create_database() -> None:
10-
"""Create a databse."""
10+
"""Create a database."""
1111
db_url = make_url(str(settings.db_url.with_path('/postgres')))
1212
engine = create_async_engine(db_url, isolation_level="AUTOCOMMIT")
1313

@@ -47,7 +47,7 @@ async def drop_database() -> None:
4747
{%- endif %}
4848
{%- if cookiecutter.db_info.name == "mysql" %}
4949
async def create_database() -> None:
50-
"""Create a databse."""
50+
"""Create a database."""
5151
engine = create_async_engine(str(settings.db_url.with_path("/mysql")))
5252

5353
async with engine.connect() as conn:
@@ -77,7 +77,7 @@ async def drop_database() -> None:
7777
{%- endif %}
7878
{%- if cookiecutter.db_info.name == "sqlite" %}
7979
async def create_database() -> None:
80-
"""Create a databse."""
80+
"""Create a database."""
8181

8282
async def drop_database() -> None:
8383
"""Drop current database."""

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/services/redis/dependency.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ async def get_redis_pool(request: Request) -> AsyncGenerator[Redis, None]: # pr
1616
>>> async with Redis(connection_pool=redis_pool) as redis:
1717
>>> await redis.get('key')
1818
19-
I use pools so you don't acquire connection till the end of the handler.
19+
I use pools, so you don't acquire connection till the end of the handler.
2020
2121
:param request: current request.
2222
:returns: redis connection pool.

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/tests/test_echo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ async def test_echo(fastapi_app: FastAPI, client: AsyncClient) -> None:
1010
Tests that echo route works.
1111
1212
:param fastapi_app: current application.
13-
:param client: clien for the app.
13+
:param client: client for the app.
1414
"""
1515
{%- if cookiecutter.api_type == 'rest' %}
1616
url = fastapi_app.url_path_for('send_echo_message')

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/web/api/dummy/views.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async def get_dummy_models(
2222
:param limit: limit of dummy objects, defaults to 10.
2323
:param offset: offset of dummy objects, defaults to 0.
2424
:param dummy_dao: DAO for dummy models.
25-
:return: list of dummy obbjects from database.
25+
:return: list of dummy objects from database.
2626
"""
2727
return await dummy_dao.get_all_dummies(limit=limit, offset=offset)
2828

0 commit comments

Comments
 (0)