Skip to content
This repository has been archived by the owner on Nov 10, 2024. It is now read-only.

Commit

Permalink
Cleanup remnants of name change (#236)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dosenpfand authored Oct 9, 2023
1 parent 992e333 commit e957135
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ If applicable, add screenshots to help explain your problem.

**Environment:**
- OS: [e.g. Linux / Windows / macOS]
- FastAPI Utils, FastAPI, and Pydantic versions [e.g. `0.3.0`], get them with:
- FastAPI RESTful, FastAPI, and Pydantic versions [e.g. `0.3.0`], get them with:

```Python
import fastapi_utils
import fastapi_restful
import fastapi
import pydantic.utils
print(fastapi_utils.__version__)
print(fastapi_restful.__version__)
print(fastapi.__version__)
print(pydantic.utils.version_info())
```
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Once you've cloned the repository, here are some guidelines to set up your envir

### Set up the development environment

After cloning the repository, you can use `poetry` to create a virtual environment:
After cloning the repository, you can use `poetry` to create a virtual environment:

```console
$ make develop
Expand All @@ -25,15 +25,15 @@ Once the virtual environment is created, you can activate it with:
$ poetry shell
```

To check if this worked, try running:
To check if this worked, try running:

```console
$ which python

some/directory/fastapi-utils-SOMETHING-py3.X/bin/python
some/directory/fastapi-restful-SOMETHING-py3.X/bin/python
```

If the output of this command shows the `python` binary in a path containing `fastapi-utils` somewhere in the name
If the output of this command shows the `python` binary in a path containing `fastapi-restful` somewhere in the name
(as above), then it worked! 🎉

!!! tip
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</a>
<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/FastApi-RESTful.svg" alt="Python versions">
<img src="https://img.shields.io/github/license/yuval9313/fastapi-utils.svg" alt="License">
<img src="https://img.shields.io/github/license/yuval9313/FastApi-RESTful.svg" alt="License">
</a>
</p>

Expand All @@ -41,7 +41,7 @@ This package includes a number of utilities to help reduce boilerplate and reuse

* **Resource Class**: Create CRUD with ease the OOP way with `Resource` base class that lets you implement methods quick.
* **Class Based Views**: Stop repeating the same dependencies over and over in the signature of related endpoints.
* **Response-Model Inferring Router**: Let FastAPI infer the `response_model` to use based on your return type annotation.
* **Response-Model Inferring Router**: Let FastAPI infer the `response_model` to use based on your return type annotation.
* **Repeated Tasks**: Easily trigger periodic tasks on server startup
* **Timing Middleware**: Log basic timing information for every request
* **OpenAPI Spec Simplification**: Simplify your OpenAPI Operation IDs for cleaner output from OpenAPI Generator
Expand All @@ -52,12 +52,12 @@ This package includes a number of utilities to help reduce boilerplate and reuse
It also adds a variety of more basic utilities that are useful across a wide variety of projects:

* **APIModel**: A reusable `pydantic.BaseModel`-derived base class with useful defaults
* **APISettings**: A subclass of `pydantic.BaseSettings` that makes it easy to configure FastAPI through environment variables
* **APISettings**: A subclass of `pydantic.BaseSettings` that makes it easy to configure FastAPI through environment variables
* **String-Valued Enums**: The `StrEnum` and `CamelStrEnum` classes make string-valued enums easier to maintain
* **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back
* **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables

See the [docs](https://fastapi-restful.netlify.app/) for more details and examples.
See the [docs](https://fastapi-restful.netlify.app/) for more details and examples.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion fastapi_restful/cbv.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def cbv(router: APIRouter, *urls: str) -> Callable[[Type[T]], Type[T]]:
will be populated with an instance created using FastAPI's dependency-injection.
For more detail, review the documentation at
https://fastapi-utils.davidmontague.xyz/user-guide/class-based-views/#the-cbv-decorator
https://fastapi-restful.netlify.app/user-guide/class-based-views//#the-cbv-decorator
"""

def decorator(cls: Type[T]) -> Type[T]:
Expand Down
4 changes: 2 additions & 2 deletions fastapi_restful/timing.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from starlette.routing import Match, Mount
from starlette.types import Scope

TIMER_ATTRIBUTE = "__fastapi_utils_timer__"
TIMER_ATTRIBUTE = "__fastapi_restful_timer__"


def add_timing_middleware(
Expand Down Expand Up @@ -59,7 +59,7 @@ def record_timing(request: Request, note: str | None = None) -> None:
This can help profile which piece of a request is causing a performance bottleneck.
Note that for this function to succeed, the request should have been generated by a FastAPI app
that has had timing middleware added using the `fastapi_utils.timing.add_timing_middleware` function.
that has had timing middleware added using the `fastapi_restful.timing.add_timing_middleware` function.
"""
timer = getattr(request.state, TIMER_ATTRIBUTE, None)
if timer is not None:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ license = "MIT"
authors = ["Yuval Levi <yuvall9313@gmail.com>"]
readme = "README.md"
homepage = "https://fastapi-restful.netlify.app"
repository = "https://github.com/yuval9313/fastapi-utils"
repository = "https://github.com/yuval9313/FastApi-RESTful"
documentation = "https://fastapi-restful.netlify.app"
keywords = ["fastapi", "OOP", "RESTful"]
classifiers = [
Expand Down

0 comments on commit e957135

Please sign in to comment.