Skip to content

Commit

Permalink
Bump dependencies
Browse files Browse the repository at this point in the history
Update LICENSE
Update README.md
  • Loading branch information
Donnype committed Oct 17, 2024
1 parent a152fd6 commit 4751780
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 29 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 BiteStreams
Copyright (c) 2022 Donny Peeters

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Docker makes it easy to get started and enables easier switching between project

To start up the project locally you first clone the project, and then run the following command in the cloned directory:
```sh
$ git clone https://github.com/BiteStreams/fastapi-template.git
$ git clone https://github.com/Donnype/fastapi-template.git
$ cd fastapi-template
$ make up
```
Expand All @@ -35,15 +35,17 @@ Run `make help` to get an overview of the available commands:
$ make help
up:
Run the application
done: lint test
done: check test
Prepare for a commit
test: utest itest
Run unit and integration tests
check:
utest: cleantest
Run unit tests
itest: cleantest
Run integration tests
check: cleantest
Check the code base
lint:
Check the code base, and fix it
clean_test:
cleantest:
Clean up test containers
migrations:
Generate a migration using alembic
Expand Down Expand Up @@ -81,10 +83,11 @@ You can run the tests using:
```bash
$ make test
```
This runs the integration & unit tests. If you want to run them separately, use `make itest` to run the integration tests and `make utest` to run the unit tests.
This runs the integration & unit tests.
If you want to run them separately, use `make itest` to run the integration tests and `make utest` to run the unit tests.


## Further reading

To read about the benefits of using this template,
check out [our blog post](https://bitestreams.com/blog/fastapi_template/).
check out [my blog post](https://bitestreams.com/blog/fastapi_template/).
30 changes: 16 additions & 14 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[tool.poetry]
name = "fastapi-template"
version = "1.2.0"
version = "1.3.0"

authors = ["Donny Peeters <[email protected]>"]
maintainers = ["Donny Peeters <[email protected]>"]
description = "A FastAPI template."
description = "A FastAPI and SQLAlchemy project template with Docker and GitHub Actions."
readme = "README.md"
homepage = "https://github.com/BiteStreams/fastapi-template"
repository = "https://github.com/BiteStreams/fastapi-template"
homepage = "https://github.com/Donnype/fastapi-template"
repository = "https://github.com/Donnype/fastapi-template"
keywords = ["FastAPI", "Template"]


[tool.poetry.dependencies]
python = "^3.10"
requests = "^2.32.0"
fastapi = "^0.109.1"
uvicorn = "^0.18.3"
fastapi = "^0.115.2"
uvicorn = "^0.32.0"
SQLAlchemy = "^1.4.42"
alembic = "^1.8.1"
psycopg2-binary = "^2.9.9"
Expand Down

0 comments on commit 4751780

Please sign in to comment.