Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.8.0 #343

Merged
merged 6 commits into from
Nov 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</p>

---
**Documentation**: <a href="https://fastapi-utils.davidmontague.xyz" target="_blank">https://fastapi-utils.davidmontague.xyz</a>
**Documentation**: <a href="https://fastapiutils.github.io/fastapi-utils/" target="_blank">https://fastapiutils.github.io/fastapi-utils/</a>

**Source Code**: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>

Expand Down Expand Up @@ -53,7 +53,7 @@ It also adds a variety of more basic utilities that are useful across a wide var
* **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-utils.davidmontague.xyz/) for more details and examples.
See the [docs](https://fastapiutils.github.io/fastapi-utils//) for more details and examples.

## Requirements

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</p>

---
**Documentation**: <a href="https://fastapi-utils.davidmontague.xyz" target="_blank">https://fastapi-utils.davidmontague.xyz</a>
**Documentation**: <a href="https://fastapiutils.github.io/fastapi-utils/" target="_blank">https://fastapiutils.github.io/fastapi-utils/</a>

**Source Code**: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>

Expand Down Expand Up @@ -53,7 +53,7 @@ It also adds a variety of more basic utilities that are useful across a wide var
* **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://https://fastapi-utils.davidmontague.xyz/) for more details and examples.
See the [docs](https://https://fastapiutils.github.io/fastapi-utils//) for more details and examples.

## Requirements

Expand Down
48 changes: 24 additions & 24 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
site_name: FastAPI Utilities
site_description: FastAPI utilities
site_url: https://fastapi-utils.davidmontague.xyz/
site_url: https://fastapiutils.github.io/fastapi-utils//

theme:
name: 'material'
name: "material"
palette:
primary: 'green'
accent: 'orange'
logo: 'img/icon-white.svg'
favicon: 'img/favicon.png'
primary: "green"
accent: "orange"
logo: "img/icon-white.svg"
favicon: "img/favicon.png"

repo_name: dmontagu/fastapi-utils
repo_url: https://github.com/dmontagu/fastapi-utils

nav:
- FastAPI Utilities: 'index.md'
- FastAPI Utilities: "index.md"
- User Guide:
- Class Resource: 'user-guide/class-resource.md'
- Class Based Views: 'user-guide/class-based-views.md'
- Repeated Tasks: 'user-guide/repeated-tasks.md'
- Timing Middleware: 'user-guide/timing-middleware.md'
- SQLAlchemy Sessions: 'user-guide/session.md'
- OpenAPI Spec Simplification: 'user-guide/openapi.md'
- Class Resource: "user-guide/class-resource.md"
- Class Based Views: "user-guide/class-based-views.md"
- Repeated Tasks: "user-guide/repeated-tasks.md"
- Timing Middleware: "user-guide/timing-middleware.md"
- SQLAlchemy Sessions: "user-guide/session.md"
- OpenAPI Spec Simplification: "user-guide/openapi.md"
- Other Utilities:
- APIModel: 'user-guide/basics/api-model.md'
- APISettings: 'user-guide/basics/api-settings.md'
- String-Valued Enums: 'user-guide/basics/enums.md'
- CamelCase Conversion: 'user-guide/basics/camelcase.md'
- GUID Type: 'user-guide/basics/guid-type.md'
- Get Help: 'help-fastapi-utils.md'
- Development - Contributing: 'contributing.md'
- Release Notes: 'release-notes.md'
- APIModel: "user-guide/basics/api-model.md"
- APISettings: "user-guide/basics/api-settings.md"
- String-Valued Enums: "user-guide/basics/enums.md"
- CamelCase Conversion: "user-guide/basics/camelcase.md"
- GUID Type: "user-guide/basics/guid-type.md"
- Get Help: "help-fastapi-utils.md"
- Development - Contributing: "contributing.md"
- Release Notes: "release-notes.md"

markdown_extensions:
- toc:
Expand All @@ -47,8 +47,8 @@ markdown_extensions:

extra:
social:
- icon: 'fontawesome/brands/github-alt'
link: 'https://github.com/dmontagu/fastapi-utils'
- icon: "fontawesome/brands/github-alt"
link: "https://github.com/dmontagu/fastapi-utils"

extra_css:
- 'css/custom.css'
- "css/custom.css"
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description = "Reusable utilities for FastAPI"
license = "MIT"
authors = ["Yuval Levi <[email protected]>", "David Montague <[email protected]>"]
readme = "README.md"
homepage = "https://fastapi-utils.davidmontague.xyz"
homepage = "https://fastapiutils.github.io/fastapi-utils/"
repository = "https://github.com/dmontagu/fastapi-utils"
documentation = "https://fastapi-utils.davidmontague.xyz"
documentation = "https://fastapiutils.github.io/fastapi-utils/"
keywords = ["fastapi", "OOP", "RESTful"]
classifiers = [
"Intended Audience :: Information Technology",
Expand All @@ -28,7 +28,6 @@ classifiers = [
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
Expand Down