Custom API written in Python using FastAPI
Project description
API
This is a custom API, written in Python using FastAPI, to help me accomplish tasks the can be improved through a RESTful API
Setup
Simplest setup is to start from compose.yml and template.env, which should be renamed to .env
Environment Vairables
API_KEY- Any long, random string. Keep this secret as this is the only form of authentication for the API. All routes require it, except/health-check/DATABASE_URL- The URL to connect to postgres DB. Must start withpostgresql+psycopg://. Should be in the format specifiec in template.envTZ- Timezone of the containerPGTZ- Timezone the Postgres container should use
How to Access
Using the compose.yml file, you can access the API at http://<IP>:5000/health-check. If everything is setup correctly, you should see {"status":"ok"}
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file js_api-0.1.0.tar.gz.
File metadata
- Download URL: js_api-0.1.0.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c6bf737d60c73b94ba71403e560dd5ce19d3bdc6f4063103b4885b18d6381b0
|
|
| MD5 |
600af4a82ce72550c1570e6adc0d522d
|
|
| BLAKE2b-256 |
054f7ff1b534759541b27678d9e79a8d0e30d081931a6e14c0b22b3911da019f
|
Provenance
The following attestation bundles were made for js_api-0.1.0.tar.gz:
Publisher:
ci-cd.yml on jnstockley/api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
js_api-0.1.0.tar.gz -
Subject digest:
9c6bf737d60c73b94ba71403e560dd5ce19d3bdc6f4063103b4885b18d6381b0 - Sigstore transparency entry: 182666062
- Sigstore integration time:
-
Permalink:
jnstockley/api@bedc040b33dc740c55bacbe030b328fb77214c7f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/jnstockley
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci-cd.yml@bedc040b33dc740c55bacbe030b328fb77214c7f -
Trigger Event:
release
-
Statement type:
File details
Details for the file js_api-0.1.0-py3-none-any.whl.
File metadata
- Download URL: js_api-0.1.0-py3-none-any.whl
- Upload date:
- Size: 18.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe02ad44fbc1eb677faff2e5ebd4161b079cb7075e76fc769e235c5f187d6616
|
|
| MD5 |
eadfa120ebf1617d4ee61a14e0de7f46
|
|
| BLAKE2b-256 |
e1bf635955743b56db9c648885719f8909031e484d330815c8482ba2549c1b95
|
Provenance
The following attestation bundles were made for js_api-0.1.0-py3-none-any.whl:
Publisher:
ci-cd.yml on jnstockley/api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
js_api-0.1.0-py3-none-any.whl -
Subject digest:
fe02ad44fbc1eb677faff2e5ebd4161b079cb7075e76fc769e235c5f187d6616 - Sigstore transparency entry: 182666067
- Sigstore integration time:
-
Permalink:
jnstockley/api@bedc040b33dc740c55bacbe030b328fb77214c7f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/jnstockley
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci-cd.yml@bedc040b33dc740c55bacbe030b328fb77214c7f -
Trigger Event:
release
-
Statement type:
