Merge pull request #963 from sanders41/typos

Fix typos

Author: sanders41

CONTRIBUTING.md

@@ -75,7 +75,7 @@ To check with the FastAPI feature enabled
 cargo clippy -F fastapi
 ```
 
-#### Run the code formater
+#### Run the code formatter
 
 ```sh
 cargo fmt --all
@@ -245,7 +245,7 @@ git fetch upstream
 git rebase upstream/main
 ```
 
-There may be some merge conficts that need to be resolved. After the feature branch has been update
+There may be some merge conflicts that need to be resolved. After the feature branch has been update
 locally, you can now update your pull request by pushing to the branch on GitHub:
 
 ```sh

README.md

@@ -5,11 +5,11 @@
 
 Generates a Python project structure with github actions for continuous integration and continuous
 deployment. Both pure Python projects and Python projects with Rust modules using PyO3 can be
-created. Addtionally FastAPI projects can be generated.
+created. Additionally FastAPI projects can be generated.
 
 ## Pure Python project included packages
 
-For package managment choose between:
+For package management choose between:
 
 - [poetry](https://python-poetry.org/)
 - [setuptools](https://github.com/pypa/setuptools)
@@ -106,7 +106,7 @@ python-project create
 ```
 
 You will be asked a series of questions that will be used to generate your project. The project
-generator will check pypi for the lastest version of the included packages and use those while
+generator will check pypi for the latest version of the included packages and use those while
 generating the project. This feature can be disabled by using with either `-s` or
 `--skip-download-latest-packages` when running the generator. If either there is an issue with
 retrieving the latest versions or if you have decided to skip looking up the latest version, the
@@ -167,7 +167,7 @@ python-project create -s
 
 - Dependabot Schedule
 
-  When dependabot is enabed the schedule controls how often dependabot will check for updates and
+  When dependabot is enabled the schedule controls how often dependabot will check for updates and
   create PRs.
 
 - Use Continuous Deployment
@@ -205,33 +205,33 @@ python-project create -s
 
 - Docs Site Name
 
-  This quesion will only show if you chose `yes` for `Include Docs`. This value sets the site name
+  This question will only show if you chose `yes` for `Include Docs`. This value sets the site name
   field for mkdocs.
 
 - Docs Site Description
 
-  This quesion will only show if you chose `yes` for `Include Docs`. This value provides a
+  This question will only show if you chose `yes` for `Include Docs`. This value provides a
   a description of the repo to use in the docs.
 
 - Docs Site URL
 
-  This quesion will only show if you chose `yes` for `Include Docs`. This is the URL where the docs
+  This question will only show if you chose `yes` for `Include Docs`. This is the URL where the docs
   will be hosted.
 
 - Docs Locale
 
-  This quesion will only show if you chose `yes` for `Include Docs`, and controls the language of
+  This question will only show if you chose `yes` for `Include Docs`, and controls the language of
   the docs.
 
 - Repo Name
 
-  This quesion will only show if you chose `yes` for `Include Docs`. This is the name of the repo
+  This question will only show if you chose `yes` for `Include Docs`. This is the name of the repo
   the docs are referencing. For example in this repository the repo name would be
   `sanders41/python-project-generator`.
 
 - Repo URL
 
-  This quesion will only show if you chose `yes` for `Include Docs`. This is URL for the repo the
+  This question will only show if you chose `yes` for `Include Docs`. This is URL for the repo the
   docs are referencing. For example in this repository the repo url would be
   `https://github.com/sanders41/python-project-generator`
 
@@ -351,7 +351,7 @@ python-project config reset
 
 [just](https://github.com/casey/just) allows you to add project specific commands to the project
 that can be run from the command line. It is very similar to [make](https://github.com/mirror/make)
-but has the advantage of being cross platform compatable and purposee build for running commands.
+but has the advantage of being cross platform compatible and purposee build for running commands.
 
 As an example, if you have the following in the `justfile` (this is included with the default file
 generated by this project):
@@ -410,14 +410,14 @@ just lint
 provided .pre-commit-config.yaml file) every time you make a commit to your code. If any of the
 lints fail pre-commit will cancel the commit. When possible, pre-commit will also automatically
 fix any errors that fail. For example pre-commit can automatically apply changes that fail ruff
-fromatting. pre-commit caches information and only runs on files that have changed so it is fast
+formatting. pre-commit caches information and only runs on files that have changed so it is fast
 and doesn't slow down your work flow will preventing you from forgetting to run checks.
 
 ### FastAPI migrations
 
 [sqlx](https://github.com/launchbadge/sqlx) is used for migrations. A dedicated docker container
 runs the migrations each time docker is started. For creating new migrations install `sqlx-cli`.
-`sqlx-cli` also needs to be instealled in order to run the generated test suite.
+`sqlx-cli` also needs to be installed in order to run the generated test suite.
 
 ```sh
 cargo install sqlx-cli --no-default-features --features native-tls,postgres

src/cli.rs

@@ -104,7 +104,7 @@ pub enum Param {
     /// Save a default value for Is Application
     ApplicationOrLibrary { value: ApplicationOrLib },
 
-    /// Remove the saved application or libary value
+    /// Remove the saved application or library value
     ResetApplicationOrLibrary,
 
     /// Save default Python versions for GitHub Action testing

src/config.rs

@@ -757,7 +757,7 @@ mod tests {
     }
 
     #[test]
-    fn test_save_github_actions_pythong_test_versions() {
+    fn test_save_github_actions_python_test_versions() {
         let config = mock_config();
         let expected = vec!["3.11".to_string(), "3.12".to_string()];
         config
@@ -769,7 +769,7 @@ mod tests {
     }
 
     #[test]
-    fn test_reset_github_actions_pythong_test_versions() {
+    fn test_reset_github_actions_python_test_versions() {
         let config = mock_config();
         config
             .save_github_actions_python_test_versions("3.11, 3.12".to_string())

src/fastapi/fastapi_files.rs

@@ -182,7 +182,7 @@ logger.add(sys.stderr, level=settings.LOG_LEVEL)
 
 @asynccontextmanager
 async def lifespan(_: FastAPI) -> AsyncGenerator:  # pragma: no cover
-    logger.info("Initalizing database connection pool")
+    logger.info("Initializing database connection pool")
     try:
         await db.create_pool()
     except Exception as e:

src/fastapi/fastapi_installer.rs

@@ -23,17 +23,17 @@ const FASTAPI_BASE_DEV_DEPENDENCIES: &[&str] = &["httpx", "pytest-xdist"];
 
 pub fn install_fastapi_dependencies(project_info: &ProjectInfo) -> Result<()> {
     match project_info.project_manager {
-        ProjectManager::Uv => uv_fastapi_depencency_installer(project_info)?,
-        ProjectManager::Poetry => poetry_fastapi_depencency_installer(project_info)?,
-        ProjectManager::Setuptools => setuptools_fastapi_depencency_installer(project_info)?,
+        ProjectManager::Uv => uv_fastapi_dependency_installer(project_info)?,
+        ProjectManager::Poetry => poetry_fastapi_dependency_installer(project_info)?,
+        ProjectManager::Setuptools => setuptools_fastapi_dependency_installer(project_info)?,
         ProjectManager::Pixi => bail!("Pixi is not currently supported for FastAPI projects"),
-        ProjectManager::Maturin => maturin_fastapi_depencency_installer(project_info)?,
+        ProjectManager::Maturin => maturin_fastapi_dependency_installer(project_info)?,
     };
 
     Ok(())
 }
 
-fn uv_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()> {
+fn uv_fastapi_dependency_installer(project_info: &ProjectInfo) -> Result<()> {
     let dependencies = FASTAPI_BASE_DEPENDENCIES.to_vec();
     /* if project_info.database_manager == Some(DatabaseManager::SqlAlchemy) {
         dependencies.push("sqlalchemy");
@@ -67,7 +67,7 @@ fn uv_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()> {
     Ok(())
 }
 
-fn poetry_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()> {
+fn poetry_fastapi_dependency_installer(project_info: &ProjectInfo) -> Result<()> {
     let dependencies = FASTAPI_BASE_DEPENDENCIES.to_vec();
     /* if project_info.database_manager == Some(DatabaseManager::SqlAlchemy) {
         dependencies.push("sqlalchemy");
@@ -101,7 +101,7 @@ fn poetry_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()>
     Ok(())
 }
 
-fn setuptools_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()> {
+fn setuptools_fastapi_dependency_installer(project_info: &ProjectInfo) -> Result<()> {
     let venv_output = std::process::Command::new("python")
         .args(["-m", "venv", ".venv"])
         .current_dir(project_info.base_dir())
@@ -147,15 +147,15 @@ fn setuptools_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result
     Ok(())
 }
 
-fn maturin_fastapi_depencency_installer(project_info: &ProjectInfo) -> Result<()> {
+fn maturin_fastapi_dependency_installer(project_info: &ProjectInfo) -> Result<()> {
     use crate::project_info::Pyo3PythonManager;
 
     if let Some(pyo3_python_manager) = &project_info.pyo3_python_manager {
         match pyo3_python_manager {
-            Pyo3PythonManager::Uv => uv_fastapi_depencency_installer(project_info),
-            Pyo3PythonManager::Setuptools => setuptools_fastapi_depencency_installer(project_info),
+            Pyo3PythonManager::Uv => uv_fastapi_dependency_installer(project_info),
+            Pyo3PythonManager::Setuptools => setuptools_fastapi_dependency_installer(project_info),
         }
     } else {
-        bail!("No Python project mangager provided for PyO3 project");
+        bail!("No Python project manager provided for PyO3 project");
     }
 }

src/fastapi/model_files.rs

@@ -31,7 +31,7 @@ fn create_token_models_file() -> String {
 
 
 class Token(BaseModel):
-    """Don't use CamelBase here because FastAPI requires snake case vairables for the token."""
+    """Don't use CamelBase here because FastAPI requires snake case variables for the token."""
 
     access_token: str
     token_type: str = "bearer"

src/fastapi/route_files.rs

@@ -131,7 +131,7 @@ async def get_current_user(pool: DbPool, cache_client: CacheClient, token: Token
             detail="Could not validate credentials",
         ) from e
     if token_data.sub is None:  # pragma: no cover
-        logger.debug("Token does not countain sub data")
+        logger.debug("Token does not contain sub data")
         raise HTTPException(
             status_code=HTTP_403_FORBIDDEN, detail="Count not validate credientials"
         )

src/fastapi/test_files.rs

@@ -574,7 +574,7 @@ pub fn save_login_route_test_file(project_info: &ProjectInfo) -> Result<()> {
     Ok(())
 }
 
-fn create_test_uitls_file(project_info: &ProjectInfo) -> String {
+fn create_test_utils_file(project_info: &ProjectInfo) -> String {
     let module = &project_info.module_name();
 
     format!(
@@ -614,7 +614,7 @@ async def get_superuser_token_headers(test_client):
 pub fn save_test_utils_file(project_info: &ProjectInfo) -> Result<()> {
     let base = &project_info.base_dir();
     let file_path = base.join("tests/utils.py");
-    let file_content = create_test_uitls_file(project_info);
+    let file_content = create_test_utils_file(project_info);
 
     save_file_with_content(&file_path, &file_content)?;
 

src/github_actions.rs

@@ -1462,7 +1462,7 @@ jobs:
     - name: Set up Python
       run: pixi add python=="${{{{ env.PYTHON_VERSION }}}}.*"
     - name: Ruff format check
-      run: pixi run run-ruff-formar
+      run: pixi run run-ruff-former
     - name: Lint with ruff
       run: pixi run run-ruff-check
     - name: mypy check