Merge pull request #2 from ispaneli/develop

Add minor updates

Author: ispaneli

README.md

@@ -46,13 +46,13 @@ To deploy the FStorage on the **server**:
 pip install 'fstorage[server]'
 ```
 
-To use a **synchronous client**:
+To use **synchronous client**:
 
 ```bash
 pip install 'fstorage[sync_client]'
 ```
 
-To use a **asynchronous client**:
+To use **asynchronous client**:
 
 ```bash
 pip install 'fstorage[async_client]'
@@ -65,8 +65,8 @@ pip install 'fstorage[async_client]'
 Configure virtual environment variables in terminal:
 
 ```bash
-export POSTGRESQL_URL="postgres://<username>:<password>@<ip_address>:<port>/<database_name>"
-export STORAGE_PATH="/Users/<local_user>/.fstorage/storage"
+export POSTGRESQL_URL="postgresql+asyncpg://<db_username>:<db_password>@<db_host>:<db_port>/<db_name>"
+export STORAGE_PATH="/Users/<local_username>/.fstorage/storage"
 ```
 
 Configure **logging.ini**:
@@ -91,7 +91,7 @@ format=[%(asctime)s.%(msecs)03d] %(levelname)s [%(thread)d] - %(message)s
 [handler_logfile]
 class=handlers.RotatingFileHandler
 level=INFO
-args=('/Users/<local_user>/.fstorage/logfile.log', 'a')
+args=('/Users/<local_username>/.fstorage/logfile.log', 'a')
 formatter=logformatter
 
 [handler_logconsole]

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -45,7 +45,6 @@ classifiers =
     Programming Language :: Python
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
@@ -69,7 +68,7 @@ classifiers =
 package_dir =
     =src
 packages = find:
-python_requires = >=3.7, <4
+python_requires = >=3.8, <4
 # install_requires =
 
 [options.extras_require]

setup.py

@@ -1,3 +1,27 @@
 __author__ = 'ispaneli'
 __email__ = '[email protected]'
+
 __version__ = '0.0.3'
+
+__doc__ = """
+FStorage
+=====
+
+It's a simple asynchronous secure file storage for microservices.
+It is implemented on the FastAPI web framework.
+
+To run the file storage, you need PostgreSQL installed.
+
+WARNING: With the usual installation of `pip install fstorage`,
+         the requirements are not installed!
+         Installation recommendations:
+             1. `pip install 'fstorage[server]'` - to deploy file storage;
+             2. `pip install 'fstorage[sync_client]'` - to use SYNC client;
+             3. `pip install 'fstorage[async_client]'` - to use ASYNC client.
+
+----------------------------
+
+Author: @ispaneli
+E-mail: [email protected]
+GitHub repository: <https://github.com/ispaneli/fstorage>
+"""