https://github.com/thevickypedia/user_profile_database

A database created using SQLite3 and accessed via FastAPI to create and maintain UserProfiles
https://github.com/thevickypedia/user_profile_database

fastapi sphinx-doc swagger-ui user-profiling

Last synced: about 2 months ago
JSON representation

A database created using SQLite3 and accessed via FastAPI to create and maintain UserProfiles

• Host: GitHub
• URL: https://github.com/thevickypedia/user_profile_database
• Owner: thevickypedia
• License: mit
• Archived: true
• Created: 2021-11-21T18:07:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-04T21:19:23.000Z (over 4 years ago)
• Last Synced: 2025-04-06T16:31:45.061Z (about 1 year ago)
• Topics: fastapi, sphinx-doc, swagger-ui, user-profiling
• Language: Python
• Homepage: https://thevickypedia.github.io/user_profile_database/
• Size: 188 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# UserProfile Database

A database created using FastAPI to create and maintain UserProfiles.

### Optional Env Variables

- `port` - Port number on which the application should run. Defaults to WW2 start year.

- `JWT_SECRET` - A secret for encoding and decoding. Defaults to url safe UUID.

### Coding Standards

Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) 


Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) 


Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 

[`isort`](https://pycqa.github.io/isort/)

### Linting

`PreCommit` will ensure linting, and the doc creation are run on every commit.

**Requirement**




`pip install --no-cache --upgrade sphinx pre-commit recommonmark`

**Usage**




`pre-commit run --all-files`

### Runbook

[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)

[https://thevickypedia.github.io/user_profile_database/](https://thevickypedia.github.io/user_profile_database/)

## License & copyright

© Vignesh Sivanandha Rao

Licensed under the [MIT License](https://github.com/thevickypedia/Jarvis/blob/master/LICENSE)