- FastAPI
- Web app using Uvicorn server
- Automated jobs using makefile
- Logging
- test files
To get started with the project, you will need to clone the repository to your local machine:
git clone [email protected]:AmgadHasan/mlops.git
Once you have cloned the repository, you can open the project in your preferred code editor and start exploring the code.
To run the project, you will need to have the following installed on your machine:
- fastapi
- uvicorn
- pytest
- pylint
You can run the following command to install these packages:
pip install -r requirements.txt
or
make install
To run the api server, go to the code directory and run the following command:
python -m uvicorn api:app --reload
or
make run
Contributions are welcome! To contribute, please follow these steps:
Fork the repository. Create a new branch for your feature or bug fix: git checkout -b my-new-feature.
Make changes and commit them:
git commit -am 'Add some feature'
Push to the branch:
git push origin my-new-feature
Submit a pull request.
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
This project was created by: Amgad Hasan
Special thanks to Ahmed ElAwady for supervising this project.
Copyright 2023 Amgad Hasan
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0