Route Solutions is a software solution designed for managing and organizing store information. This application facilitates tasks such as inserting individual stores, importing multiple stores from Excel files, efficiently deleting store records based on specified criteria, removing all stores, searching for stores by ID, and modifying store restrictions.
The application allows users to add individual stores by providing store-specific details such as ID, name, address, postcode, kilometers, and whether the store requires a tail lift. Additionally, users can specify store restrictions for each day of the week.
Users can streamline the process by importing multiple stores from an Excel file. The application parses the file, validates the data, and inserts each store into the database.
There are options to delete stores based on specific criteria or remove all stores. Users can delete a single store by providing its ID or choose to delete multiple stores by specifying criteria, such as all stores requiring a tail lift.
Users can search for a store by providing its ID. The application retrieves and displays information for the specified store if it exists. Additionally, users can search for all stores and view their store restrictions.
Users can modify the store restrictions for an existing store by providing the store ID and updating the opening hours for each day of the week.
The application utilizes logging to capture and record events during database interactions, including successful document insertions, deletions, searches, modifications, and potential errors.
The application logs important events and errors during database interactions. Separate loggers are used for different modules, including connection, deletion, insertion, modification, and search. This ensures a detailed record of activities and aids in troubleshooting.
The application operates on a MongoDB database named “StoreInformation” with a collection named “Stores.” Each document in the collection represents a store and includes fields such as ID, store name, address, postcode, kilometers, tail lift requirement, and store restrictions.
The project is organized into distinct modules for connection handling, insertion, deletion, searching, modification, and logging. The structure promotes code readability, maintainability, and the ease of extending functionality.
Follow these steps to set up Route Solutions:
-
Clone the repository to your local machine.
git clone https://github.com/your-username/route-solutions.git
-
Navigate to the project directory.
cd route-solutions -
Install the required dependencies.
pip install -r requirements.txt
-
Configure the MongoDB connection string.
-
Create a
.envfile in the project root. -
Add your MongoDB connection string as follows:
MONGO_CONNECTION_STRING=your_connection_string
-
Explore the functionalities provided by Route Solutions:
- Insert one store
- Insert many stores from an Excel file
- Delete one store by ID
- Delete many stores based on criteria or all to remove all stores
- Search for a store by ID
- Search for all stores
- Modify store restrictions for an existing store
Refer to the application structure and logging details in the previous sections for insights into its inner workings.
Now you’re ready to interact with Route Solutions. Head to the Getting Started section to run the application.
If you’re interested in contributing to Route Solutions, feel free to:
-
Fork the repository.
-
Create your feature branch:
git checkout -b feature/YourFeature
-
Commit your changes:
git commit -m “Add YourFeature”
-
Push the branch:
git push origin feature/YourFeature
-
Open a pull request, and we’ll review your contribution.
Route Solutions is licensed under the Apache License 2.0. See the LICENSE file for more details.