https://github.com/thevickypedia/fastapi_file_handler

Upload and download files using FastAPI
https://github.com/thevickypedia/fastapi_file_handler

aiofi fastapi filesystem

Last synced: 3 months ago
JSON representation

Upload and download files using FastAPI

• Host: GitHub
• URL: https://github.com/thevickypedia/fastapi_file_handler
• Owner: thevickypedia
• License: mit
• Created: 2021-11-20T03:01:57.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-01T05:07:27.000Z (almost 3 years ago)
• Last Synced: 2024-10-17T03:47:56.943Z (4 months ago)
• Topics: aiofi, fastapi, filesystem
• Language: Python
• Homepage: https://thevickypedia.github.io/api_file_handler/
• Size: 271 KB
• Stars: 4
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API File Handler

Upload and download files using FastAPI

### Usage

- [auth_apikey.py](https://github.com/thevickypedia/api_file_handler/blob/main/auth_apikey.py):

Authenticates using an APIKey that can be stored as an env var `APIKEY`. Defaults to a randomly generated url safe UUID.

- [auth_server.py](https://github.com/thevickypedia/api_file_handler/blob/main/auth_server.py):

Authenticates using the server's `USER` and `PASSWORD`. If password is not available as env var, requests from the user.

### PRO-Tip

- [jprq](https://github.com/azimjohn/jprq-python-client)

- [localtunnel](https://theboroer.github.io/localtunnel-www/)

- [ngrok](https://ngrok.com/docs)

### 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/api_file_handler/](https://thevickypedia.github.io/api_file_handler/)

## License & copyright

© Vignesh Sivanandha Rao

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