Update README.md

README.md

@@ -1 +1,91 @@
-# datascience_practice_python
+# datascience_practice_python
+# Flask RESTful API Project
+## Overview
+This project is a Flask RESTful API that provides endpoints for managing users, locations, companies, positions, and user-company mappings. It follows best practices for structuring a Flask project and includes unit tests using pytest.
+
+## Features
+* User management (CRUD operations)
+* Location management (CRUD operations)
+* Company management (CRUD operations)
+* Position management (CRUD operations)
+* User-Company Mapping management (CRUD operations)
+
+## Getting Started
+1. Install all the softwares: docker
+1. Pull the image:
+  ```
+  docker pull taranjitkaurme/datascience_practice_python:latest
+  ```
+
+3. Run the Docker container:
+  ```
+  docker run -p 5000:5000 taranjitkaurme/datascience_practice_python:latest
+  ```
+
+## Getting Started to contribute
+1. Install all the softwares: python, piipenv, docker, intelliJ, git
+
+   Note: You can also use - https://github.com/neurabytes/nb-automation-devtools
+
+3. Clone the repository:
+  ```
+  git clone https://github.com/taranjitkaurmee/datascience_practice_python.git
+  cd datascience_practice_python
+  ```
+4. Install dependencies:  
+  ```  
+  pipenv install
+  ```
+
+5. Run the Flask application:
+  ```
+  python app.py
+  ```
+The API will be accessible at http://localhost:5000.
+
+## API Endpoints
+* Users:
+  * GET: /api/users
+  * GET: /api/users/<int:user_id>
+  * POST: /api/users
+  * PUT: /api/users/<int:user_id>
+  * DELETE: /api/users/<int:user_id>
+
+* Locations:
+  * GET: /api/location
+  * GET: /api/location/<int:location_id>
+  * POST: /api/location
+  * PUT: /api/location/<int:location_id>
+  * DELETE: /api/location/<int:location_id>
+
+* Companies:
+  * GET: /api/company
+  * GET: /api/company/<int:company_id>
+  * POST: /api/company
+  * PUT: /api/company/<int:company_id>
+  * DELETE: /api/company/<int:company_id>
+
+* Positions:
+  * GET: /api/position
+  * GET: /api/position/<int:position_id>
+  * POST: /api/position
+  * PUT: /api/position/<int:position_id>
+  * DELETE: /api/position/<int:position_id>
+
+* User-Company Mappings:
+  * GET: /api/usercompanymapping
+  * GET: /api/usercompanymapping/<int:mapping_id>
+  * POST: /api/usercompanymapping
+  * PUT: /api/usercompanymapping/<int:mapping_id>
+  * DELETE: /api/usercompanymapping/<int:mapping_id>
+
+## Testing
+Run unit tests using pytest:
+  ```
+  pytest
+  ```
+## Contributing
+Feel free to contribute by reporting issues, suggesting enhancements, or submitting pull requests. 
+
+## License
+This project is licensed under the MIT License - see the LICENSE file for details.