Metadata-Version: 2.4
Name: square_file_store
Version: 2.3.6
Summary: file storage layer for my personal server.
Project-URL: homepage, https://github.com/thepmsquare/square_file_store
Author-email: Parth Mukesh Mangtani <thepmsquare@gmail.com>
License: GPLv3
License-File: LICENSE
Keywords: fastapi,file,storage,utilities
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: fastapi>=0.104.1
Requires-Dist: httpx>=0.27.2
Requires-Dist: pydantic>=2.5.3
Requires-Dist: pytest>=8.0.0
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: square-commons>=2.1.0
Requires-Dist: square-database-helper>=2.3.0
Requires-Dist: square-database-structure>=2.5.1
Requires-Dist: square-logger>=3.0.0
Requires-Dist: uvicorn>=0.24.0.post1
Description-Content-Type: text/markdown

# square_file_store

> 📌 versioning: see [CHANGELOG.md](./CHANGELOG.md).

## about

file storage layer for my personal server.

## goals

- integration with square_*
- unified file api across all projects
- simplicity first
- generic design
- future extensibility

## installation

```shell
pip install square_file_store
```

## usage

### configuration

update the settings in `config.ini` and `config.testing.ini` to match your environment (urls, logging, etc.).

### running the service

```shell
python square_file_store/main.py
```

## env

- python>=3.12.0

> feedback is appreciated. thank you!
