Skip to content

Commit 9b632b1

Browse files
john0isaacjohn0isaac
authored
Merge pull request #2 from john0isaac/improved-api
Improved api
2 parents 0da5dfb + e345698 commit 9b632b1

31 files changed

+766
-181
lines changed

‎.devcontainer/Dockerfile_dev

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
FROM mcr.microsoft.com/devcontainers/python:3.12-bullseye
2+
3+
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
4+
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*
5+
6+
7+
COPY requirements-dev.txt requirements-dev.txt
8+
COPY src/requirements.txt src/requirements.txt
9+
RUN python -m pip install --upgrade pip
10+
RUN python -m pip install -r requirements-dev.txt

‎.devcontainer/devcontainer.json

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
3+
{
4+
"name": "flask_api_sqlite_db",
5+
6+
// Update the 'dockerComposeFile' list if you have more compose files or use different names.
7+
// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
8+
"dockerComposeFile": "docker-compose_dev.yml",
9+
// The 'service' property is the name of the service for the container that VS Code should
10+
// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
11+
"service": "app",
12+
"shutdownAction": "stopCompose",
13+
"workspaceFolder": "/workspace",
14+
"forwardPorts": [5000, 3306],
15+
"portsAttributes": {
16+
"5000": {"label": "Web port", "onAutoForward": "notify"}
17+
},
18+
"customizations": {
19+
"vscode": {
20+
"extensions": [
21+
"ms-azuretools.vscode-bicep",
22+
"charliermarsh.ruff",
23+
"ms-python.python",
24+
"bierner.github-markdown-preview"
25+
],
26+
"settings": {
27+
"python.defaultInterpreterPath": "/usr/local/bin/python",
28+
"python.testing.pytestEnabled": true,
29+
"python.testing.unittestEnabled": false,
30+
"files.exclude": {
31+
".coverage": true,
32+
".pytest_cache": true,
33+
"__pycache__": true,
34+
".ruff_cache": true
35+
},
36+
"[python]": {
37+
"editor.formatOnSave": true,
38+
"editor.defaultFormatter": "charliermarsh.ruff",
39+
"editor.codeActionsOnSave": {
40+
"source.organizeImports": true,
41+
"source.fixAll": true
42+
}
43+
}
44+
}
45+
}
46+
},
47+
"features": {
48+
"ghcr.io/azure/azure-dev/azd:latest": {}
49+
},
50+
"postCreateCommand": "pip install -e src && python3 -m flask --app src/flaskapp db upgrade --directory src/flaskapp/migrations"
51+
}

‎.devcontainer/docker-compose_dev.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: '3'
2+
services:
3+
app:
4+
build:
5+
context: ..
6+
dockerfile: ./.devcontainer/Dockerfile_dev
7+
8+
command: sleep infinity

‎.github/workflows/devcontaienr-ci.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Check Dev Container
2+
3+
on:
4+
push:
5+
branches: [ 'main', 'improved-api']
6+
paths:
7+
- ".devcontainer/**"
8+
- ".github/workflows/devcontainer-ci.yaml"
9+
pull_request:
10+
branches: [ 'main', 'improved-api' ]
11+
paths:
12+
- ".devcontainer/**"
13+
- ".github/workflows/devcontainer-ci.yaml"
14+
15+
permissions:
16+
contents: read
17+
18+
jobs:
19+
build:
20+
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- uses: actions/checkout@v3
25+
- name: Use Node.js 20.x
26+
uses: actions/setup-node@v3
27+
with:
28+
node-version: 20.x
29+
- run: npm install -g @devcontainers/cli
30+
- run: devcontainer build --config ./.devcontainer/devcontainer.json --workspace-folder "$(pwd)"

‎.github/workflows/format.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Run Python linter and formatter
2+
3+
on:
4+
push:
5+
branches: [ 'main' ]
6+
paths:
7+
- '**.py'
8+
9+
pull_request:
10+
branches: [ 'main' ]
11+
paths:
12+
- '**.py'
13+
14+
jobs:
15+
checks-format:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v3
19+
- uses: actions/setup-python@v4
20+
with:
21+
python-version: 3.12
22+
cache: 'pip'
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install -r requirements-dev.txt
27+
- name: Check linting with ruff
28+
run: |
29+
ruff check .
30+
- name: Check formatting with black
31+
run: |
32+
black . --verbose

‎.github/workflows/tests.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Run Python tests
2+
3+
on:
4+
push:
5+
branches: [ 'main' ]
6+
paths:
7+
- '**.py'
8+
9+
pull_request:
10+
branches: [ 'main' ]
11+
paths:
12+
- '**.py'
13+
14+
jobs:
15+
test_package:
16+
17+
name: Test ${{ matrix.os }} Python ${{ matrix.python_version }}
18+
runs-on: ${{ matrix.os }}
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
os: ["ubuntu-20.04"]
23+
python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
24+
steps:
25+
- uses: actions/checkout@v3
26+
- name: Setup python
27+
uses: actions/setup-python@v2
28+
with:
29+
30+
python-version: ${{ matrix.python_version }}
31+
architecture: x64
32+
- name: Install dependencies
33+
run: |
34+
python3 -m pip install --upgrade pip
35+
python3 -m pip install -r requirements-dev.txt
36+
python3 -m pip install -e src
37+
- name: Run the migrations
38+
run: |
39+
python3 -m flask --app src.flaskapp db upgrade --directory src/flaskapp/migrations
40+
env:
41+
DATABASE_FILENAME: testdb.db
42+
- name: Run tests
43+
run: python3 -m pytest
44+
env:
45+
DATABASE_FILENAME: testdb.db

‎.pre-commit-config.yaml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
exclude: '^tests/snapshots/'
2+
repos:
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
rev: v4.5.0
5+
hooks:
6+
- id: check-yaml
7+
- id: end-of-file-fixer
8+
- id: trailing-whitespace
9+
- repo: https://github.com/astral-sh/ruff-pre-commit
10+
rev: v0.1.14
11+
hooks:
12+
- id: ruff
13+
- repo: https://github.com/psf/black
14+
rev: 24.1.0
15+
hooks:
16+
- id: black
17+
- repo: https://github.com/pre-commit/mirrors-prettier
18+
rev: v3.1.0
19+
hooks:
20+
- id: prettier
21+
types_or: [css, javascript, ts, tsx, html]

‎README.md

+32-16
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,58 @@ To run the Flask application, follow these steps:
1212
cd flask-api-sqlite-db
1313
```
1414

15-
1. **Install, initialize and activate a virtualenv using:**
15+
1. **Initialize and activate a virtualenv using:**
1616

1717
```bash
18-
pip install virtualenv
19-
python -m virtualenv venv
20-
source venv/bin/activate
18+
python3 -m venv .venv
19+
source .venv/bin/activate
2120
```
2221

2322
>**Note** - In Windows, the `venv` does not have a `bin` directory. Therefore, you'd use the analogous command shown below:
2423
2524
```bash
26-
source venv\Scripts\activate
25+
source .venv\Scripts\activate
2726
```
2827
29-
1. **Install the dependencies:**
28+
1. **Install the app as an editable package:**
3029
3130
```bash
32-
pip install -r requirements.txt
31+
python3 -m pip install -e src
3332
```
3433
35-
1. **Execute the following command in your terminal to start the flask app**
34+
1. **Execute the following command to add the database name and apply the migrations:**
3635
3736
```bash
3837
export DATABASE_FILENAME=testdb.db
39-
export FLASK_APP=src.app
40-
export FLASK_ENV=development
41-
flask run --reload
38+
python3 -m flask --app src.flaskapp db upgrade --directory src/flaskapp/migrations
4239
```
43-
### Run the tests
4440
45-
1. **Inside your virtual environment, execute the following command to run the tests**
41+
1. **Execute the following command to run the flask application:**
4642
4743
```bash
48-
python flask_test.py
44+
python3 -m flask --app src.flaskapp run --reload
45+
```
46+
47+
### Development
48+
49+
1. **Inside your virtual environment, execute the following command to install the development requirements:**
50+
51+
```bash
52+
pip install -r requirements-dev.txt
53+
```
54+
55+
1. **Execute the following command to install the pre commit hooks:**
56+
57+
```bash
58+
pre-commit install
59+
```
60+
61+
### Testing
62+
63+
1. **Execute the following command to run the tests**
64+
65+
```bash
66+
pytest
4967
```
5068
5169
## API Documentation
@@ -208,5 +226,3 @@ The API will return these error types when the request fails:
208226
"total_executions": 10
209227
}
210228
```
211-
212-

0 commit comments

Comments
 (0)