https://github.com/tameronline/searchyolo
https://github.com/tameronline/searchyolo
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tameronline/searchyolo
- Owner: TamerOnLine
- License: other
- Created: 2025-02-25T11:06:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-25T13:04:19.000Z (over 1 year ago)
- Last Synced: 2025-10-21T14:50:27.710Z (9 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tameronline-searchyolo
## Overview
`tameronline-searchyolo` is a lightweight and automated environment setup script designed to streamline the process of creating and activating a virtual environment across different operating systems (Windows, Linux, and macOS). This project ensures that Python dependencies are properly managed and integrated with your development workflow.
## Features
- **Cross-Platform Support**: Works seamlessly on Windows (`.bat`, `.ps1`), Linux (`.sh`), and macOS (`.sh`).
- **Automated Virtual Environment Setup**: Detects Python installation, creates a virtual environment, and activates it.
- **Pip Package Management**: Ensures the latest version of pip and installs dependencies from `requirements.txt`.
- **Integrated with VS Code**: Provides a `.code-workspace` file for one-click environment activation in Visual Studio Code.
## Installation
### Prerequisites
- **Python 3.6+** must be installed.
- **VS Code (optional)** for an integrated development experience.
### Setup Instructions
#### Windows
**Using Command Prompt:**
```cmd
cd path/to/tameronline-searchyolo
activate_project.bat
```
**Using PowerShell:**
```powershell
cd path/to/tameronline-searchyolo
.\activate_project.ps1
```
#### Linux/macOS
```bash
cd path/to/tameronline-searchyolo
chmod +x activate_project.sh
./activate_project.sh
```
### **5. Install Dependencies**
After activating the virtual environment, install the required dependencies:
```bash
pip install -r requirements.txt
```
### **6. Running the Project**
Once the environment is set up, you can run the project using the following command:
```bash
python src/search.py
```
This will fetch the data and save the output CSV file inside the `src/` directory.
## File Structure
```
tameronline-searchyolo/
├── README.md # Documentation
├── activate_project.bat # Windows CMD script
├── activate_project.ps1 # Windows PowerShell script
├── activate_project.sh # Linux/macOS Bash script
├── requirements.txt # List of dependencies
├── .gitignore # Git ignore file
├── tests/
│ ├── __init__.py # Marks the tests directory as a package
│ ├── test_example.py # Example test case
│ ├── test_search.py # Tests for search.py
└── workspace.code-workspace # VS Code workspace file
```