E-Asset Management API service

This project is a multitenant asset management system built using Fastapi with SQLalchemy ORM logic.

Document contents

• Installation
• Next steps
• Contributing
• Other notes

Installation

• Docker
• Virtualenv
• Heroku
• AWS-EC2

Setup with Docker

Dependencies

• Docker
• Docker Compose

Installation

Important: This docker-compose.yml is configured for local testing only, and is not intended for production use.

Run the following commands:

git clone https://github.com/eliblurr/asset.git
cd asset

Run:

mv docker.env.example docker.env

Setup environment variables; allowed environment variables KEYWORDS=VALUES:

KEYWORDS	VALUES	DEFAULT VALUE	VALUE TYPE	IS REQUIRED
DB_NAME		asset	string	true
DB_USER		postgres	string	true
DB_PASSWORD		postgres	string	true
WEB_PORT		2000	integer	true
REDIS_PORT		2001	integer	true
PGADMIN_PORT		2002	integer	true
POSTGRES_PORT		2003	integer	true
PGADMIN_DEFAULT_EMAIL		admin@admin.com	string	true
PGADMIN_DEFAULT_PASSWORD		changeme	string	true
BASE_URL		http://localhost	string	true
ADMIN_EMAIL		admin@admin.com	string	true
VERIFICATION_PATH			string	true
PASSWORD_RESET			string	true
EMAIL_CODE_DURATION_IN_MINUTES		15	integer	true
ACCESS_TOKEN_DURATION_IN_MINUTES		60	integer	true
REFRESH_TOKEN_DURATION_IN_MINUTES		600	integer	true
PASSWORD_RESET_TOKEN_DURATION_IN_MINUTES		15	integer	true
ACCOUNT_VERIFICATION_TOKEN_DURATION_IN_MINUTES		15	integer	true
TWILIO_PHONE_NUMBER			string	false
TWILIO_AUTH_TOKEN			string	false
TWILIO_ACCOUNT_SID			string	false
MAIL_USERNAME			string	true
MAIL_PASSWORD			string	true
MAIL_FROM			string	true
MAIL_PORT			string	true
MAIL_SERVER			string	true
MAIL_FROM_NAME			string	true
MAIL_TLS		true	boolean	true
MAIL_SSL		false	boolean	true
USE_CREDENTIALS		true	boolean	true
VALIDATE_CERTS		true	boolean	true
DEFAULT_MAIL_SUBJECT			string	true
APS_COALESCE		false	boolean	true
APS_MAX_INSTANCES		20	integer	true
APS_MISFIRE_GRACE_TIME		4	integer	true
APS_THREAD_POOL_MAX_WORKERS		20	integer	true
APS_PROCESS_POOL_MAX_WORKERS		5	integer	true
USE_S3		false	boolean	true
AWS_ACCESS_KEY_ID			string	true
AWS_SECRET_ACCESS_KEY			string	true
AWS_DEFAULT_ACL		public-read	string	true
AWS_STORAGE_BUCKET_NAME			string	true
AWS_S3_OBJECT_CACHE_CONTROL		max-age=86400	string	true
REDIS_HOST		redis	string	false
REDIS_PORT		6379	integer	false
REDIS_PASSWORD			string	true
REDIS_USER			string	true
REDIS_NODE		0	integer	true
REDIS_MAX_RETRIES		3	integer	true
REDIS_RETRY_INTERVAL		10	integer	true

Run:

docker-compose --env-file ./docker.env up -d --build

Api docs will now be accessible at {host}:{APP_PORT}/.

Down containert with command:

docker-compose --env-file ./docker.env down

Important: This docker-compose.yml is configured for local testing only, and is not intended for production use.

Debugging

To tail the logs from the Docker containers in realtime, run:

docker-compose logs -f

Setup with Virtualenv

You can run the site locally or on your server without setting up Vagrant or Docker and simply use Virtualenv, which is the recommended installation approach.

Dependencies

• Python 3.6, 3.7, 3.8 or 3.9
• Virtualenv[Optional]
• VirtualenvWrapper[Optional] (optional)

Installation

Creating your Virtualenv[Optional]

With PIP and virtualenvwrapper installed, run:

mkvirtualenv assetvenv
python --version

or

With PIP and python3 installed, run:

python3 -m venv /path/to/new/virtual/environment

Confirm that this is showing a compatible version of Python 3.x. If not, and you have multiple versions of Python installed on your system, you may need to specify the appropriate version when creating the virtualenv:

deactivate
rmvirtualenv 
mkvirtualenv assetvenv --python=python3.9
python --version

Now we're ready to set up the project:

git clone https://github.com/eliblurr/asset.git
cd asset/app
source /path/to/venv/bin/activate
pip install -r requirements.txt

Next, we'll set up our local environment variables. We use python-dotenv to help with this. It reads environment variables located in a file name .env in the top level directory of the project.

$ mv env.example .env [update enviromental variables and change accordingly]

allowed environment variables KEYWORDS=VALUES:

KEYWORDS	VALUES	DEFAULT VALUE	VALUE TYPE	IS REQUIRED
DATABASE_URL			string	true
BASE_URL		http://localhost	string	true
ADMIN_EMAIL		admin@admin.com	string	true
VERIFICATION_PATH			string	true
PASSWORD_RESET			string	true
EMAIL_CODE_DURATION_IN_MINUTES		15	integer	true
ACCESS_TOKEN_DURATION_IN_MINUTES		60	integer	true
REFRESH_TOKEN_DURATION_IN_MINUTES		600	integer	true
PASSWORD_RESET_TOKEN_DURATION_IN_MINUTES		15	integer	true
ACCOUNT_VERIFICATION_TOKEN_DURATION_IN_MINUTES		15	integer	true
TWILIO_PHONE_NUMBER			string	false
TWILIO_AUTH_TOKEN			string	false
TWILIO_ACCOUNT_SID			string	false
MAIL_USERNAME			string	true
MAIL_PASSWORD			string	true
MAIL_FROM			string	true
MAIL_PORT			string	true
MAIL_SERVER			string	true
MAIL_FROM_NAME			string	true
MAIL_TLS		true	boolean	true
MAIL_SSL		false	boolean	true
USE_CREDENTIALS		true	boolean	true
VALIDATE_CERTS		true	boolean	true
DEFAULT_MAIL_SUBJECT			string	true
APS_COALESCE		false	boolean	true
APS_MAX_INSTANCES		20	integer	true
APS_MISFIRE_GRACE_TIME		4	integer	true
APS_THREAD_POOL_MAX_WORKERS		20	integer	true
APS_PROCESS_POOL_MAX_WORKERS		5	integer	true
USE_S3		false	boolean	true
AWS_ACCESS_KEY_ID			string	true
AWS_SECRET_ACCESS_KEY			string	true
AWS_DEFAULT_ACL		public-read	string	true
AWS_STORAGE_BUCKET_NAME			string	true
AWS_S3_OBJECT_CACHE_CONTROL		max-age=86400	string	true
REDIS_HOST		redis	string	true
REDIS_PORT		6379	integer	true
REDIS_PASSWORD			string	true
REDIS_USER			string	true
REDIS_NODE		0	integer	true
REDIS_MAX_RETRIES		3	integer	true
REDIS_RETRY_INTERVAL		10	integer	true

make start script an executable[in asset/app/ directory]:

chmod +x start.sh   
chmod +x build.sh   

To build and setup application, run[in asset/app/ directory]:

./build.sh

Start app server with start script:

./start.sh

Start script options

1. -s : identifies your desired server, current options are uvicorn or gunicorn

   -s uvicorn

2. -w : identifies number of workers you want running

   -w 4

3. -p : identifies number of redis worker processes you want running

   -p 4

4. -e : all extra arguments passed in quotes for your selected server

   -e "--port 8087"

example:

./start.sh -s uvicorn -w 4 -rw 4 -e "--port 8087"

Deploy to Heroku

If you want a publicly accessible site, use Heroku's one-click deployment solution to the free 'Hobby' tier:

If you do not have a Heroku account, clicking the above button will walk you through the steps to generate one. At this point you will be presented with a screen to configure your app. For our purposes, we will accept all of the defaults and click Deploy. The status of the deployment will dynamically update in the browser. Once finished, click View to see the public site.

To learn more about Heroku, read Deploying Python and FastApi Apps on Heroku.

Deploy as AWS-EC2 Instance

To be included

Contributing

This repository is a proprietary product intended for AITI-KACE

Make a pull request to https://github.com/eliblurr/asset.git

Other notes

Ownership of content

All content in this app is private domain.