Skip to content

Commit e9f517a

Browse files
igorbenavigorbenav
authored
Initial commit
0 parents  commit e9f517a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+5405
-0
lines changed

‎.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Pull Request Template for FastAPI-boilerplate
2+
3+
## Description
4+
Please provide a clear and concise description of what your pull request is about.
5+
6+
## Changes
7+
Briefly list the changes you've made. If applicable, also link any relevant issues or pull requests.
8+
9+
## Tests
10+
Describe the tests you added or modified to cover your changes, if applicable.
11+
12+
## Checklist
13+
- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) document.
14+
- [ ] My code follows the code style of this project.
15+
- [ ] I have added necessary documentation (if appropriate).
16+
- [ ] I have added tests that cover my changes (if applicable).
17+
- [ ] All new and existing tests passed.
18+
19+
## Additional Notes
20+
Include any additional information that you think is important for reviewers to know.

‎.github/ISSUE_TEMPLATE/fastapi-boilerplate-feature-request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: FastAPI-boilerplate Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/fastapi-boilerplate-issue.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: FastAPI-boilerplate Issue
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug or question**
11+
A clear and concise description of what the bug or question is.
12+
13+
**To Reproduce**
14+
Please provide a self-contained, minimal, and reproducible example of your use case
15+
```python
16+
# Your code here
17+
```
18+
19+
**Description**
20+
Describe the problem, question, or error you are facing. Include both the expected output for your input and the actual output you're observing.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.gitignore

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
poetry.lock
112+
src/poetry.lock
113+
114+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115+
__pypackages__/
116+
117+
# Celery stuff
118+
celerybeat-schedule
119+
celerybeat.pid
120+
121+
# SageMath parsed files
122+
*.sage.py
123+
124+
# Environments
125+
.env
126+
.venv
127+
env/
128+
venv/
129+
ENV/
130+
env.bak/
131+
venv.bak/
132+
133+
# Spyder project settings
134+
.spyderproject
135+
.spyproject
136+
137+
# Rope project settings
138+
.ropeproject
139+
140+
# mkdocs documentation
141+
/site
142+
143+
# mypy
144+
.mypy_cache/
145+
.dmypy.json
146+
dmypy.json
147+
148+
# Pyre type checker
149+
.pyre/
150+
151+
# pytype static type analyzer
152+
.pytype/
153+
154+
# Cython debug symbols
155+
cython_debug/
156+
157+
# PyCharm
158+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160+
# and can be added to the global gitignore or merged into this file. For a more nuclear
161+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162+
#.idea/
163+
164+
# Macos
165+
.DS_Store
166+
167+
.ruff_cache

‎.pre-commit-config.yaml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
default_language_version:
2+
python: python3.11
3+
4+
repos:
5+
- repo: https://github.com/pre-commit/pre-commit-hooks
6+
rev: v4.1.0
7+
hooks:
8+
- id: end-of-file-fixer
9+
- id: trailing-whitespace
10+
- id: check-yaml
11+
- id: check-docstring-first
12+
- id: check-executables-have-shebangs
13+
- id: check-case-conflict
14+
- id: check-added-large-files
15+
exclude: ^(.*\/dummy.*|.*\.json)$
16+
args: ["--maxkb=750", "--enforce-all"]
17+
- id: detect-private-key
18+
- id: check-merge-conflict
19+
20+
- repo: https://github.com/asottile/pyupgrade
21+
rev: v3.15.0
22+
hooks:
23+
- id: pyupgrade
24+
args: [--py310-plus]
25+
name: Upgrade code to Python 3.10+
26+
27+
- repo: https://github.com/myint/docformatter
28+
rev: v1.7.5
29+
hooks:
30+
- id: docformatter
31+
args: [--in-place, --wrap-summaries=115, --wrap-descriptions=120]
32+
33+
- repo: https://github.com/asottile/yesqa
34+
rev: v1.5.0
35+
hooks:
36+
- id: yesqa
37+
name: Unused noqa
38+
39+
- repo: https://github.com/astral-sh/ruff-pre-commit
40+
rev: v0.1.9
41+
hooks:
42+
- id: ruff
43+
args: [ --fix ]
44+
- id: ruff-format
45+
46+
- repo: https://github.com/asottile/blacken-docs
47+
rev: 1.16.0
48+
hooks:
49+
- id: blacken-docs
50+
args: [--line-length=120]
51+
additional_dependencies: [black==22.1.0]
52+
53+
- repo: https://github.com/executablebooks/mdformat
54+
rev: 0.7.17
55+
hooks:
56+
- id: mdformat
57+
additional_dependencies:
58+
- mdformat-gfm
59+
- mdformat_frontmatter
60+
exclude: CHANGELOG.md
61+
62+
- repo: local
63+
hooks:
64+
- id: unit_test
65+
name: Unit test
66+
language: system
67+
entry: poetry run pytest
68+
pass_filenames: false
69+
always_run: true
70+
types: [python]
71+
stages: [manual]

0 commit comments

Comments
 (0)