Technologic101 commited on
Commit
5960996
·
1 Parent(s): 50cdda4

build: Inits jupyter notebook and dependencies

Browse files
Files changed (4) hide show
  1. .gitignore +7 -0
  2. README.md +65 -0
  3. notebook.ipynb +1 -0
  4. requirements.txt +26 -0
.gitignore ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ .env
2
+ .env.local
3
+ .env.development.local
4
+ .env.test.local
5
+ .env.production.local
6
+
7
+ .venv
README.md CHANGED
@@ -229,4 +229,69 @@ An **agentic CSS style creator** can bridge the gap by understanding style reque
229
  - Validate HTML structure
230
  - Ensure complete metadata
231
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
232
 
 
229
  - Validate HTML structure
230
  - Ensure complete metadata
231
 
232
+ ## Setup
233
+
234
+ This project uses uv for package management and Jupyter Notebook for development.
235
+
236
+ ### Prerequisites
237
+
238
+ 1. Install uv:
239
+ ```bash
240
+ # On Unix-like systems (Linux, macOS)
241
+ curl -LsSf https://astral.sh/uv/install.sh | sh
242
+
243
+ # On Windows (PowerShell)
244
+ powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
245
+ ```
246
+
247
+ ### Environment Setup
248
+
249
+ 1. Initialize a new project with uv:
250
+ ```bash
251
+ # Create and activate a new virtual environment
252
+ uv venv
253
+
254
+ # Activate the virtual environment:
255
+ # On Windows:
256
+ .venv\Scripts\activate
257
+ # On Unix-like systems:
258
+ source .venv/bin/activate
259
+ ```
260
+
261
+ 2. Create and use requirements.txt for dependencies:
262
+ ```bash
263
+ # Create requirements.txt
264
+ cat > requirements.txt << EOL
265
+ jupyter
266
+ notebook
267
+ beautifulsoup4
268
+ scrapy
269
+ selenium
270
+ playwright
271
+ pandas
272
+ numpy
273
+ EOL
274
+
275
+ # Install dependencies
276
+ uv pip install -r requirements.txt
277
+ ```
278
+
279
+ 3. Start Jupyter Notebook:
280
+ ```bash
281
+ jupyter notebook
282
+ ```
283
+
284
+ 4. Configure environment variables:
285
+ - Copy the `.env.example` file to `.env`
286
+ - Add your API keys and configuration:
287
+ ```bash
288
+ cp .env.example .env
289
+ # Edit .env with your preferred text editor
290
+ ```
291
+
292
+ Required environment variables:
293
+ - `OPENAI_API_KEY`: Your OpenAI API key
294
+ - `HUGGINGFACE_API_KEY`: Your Hugging Face API key
295
+ - Additional configuration options are documented in the `.env` file
296
+
297
 
notebook.ipynb ADDED
@@ -0,0 +1 @@
 
 
1
+
requirements.txt ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Jupyter environment
2
+ jupyter
3
+ notebook
4
+
5
+ # Web scraping and automation
6
+ beautifulsoup4
7
+ scrapy
8
+ selenium
9
+ playwright
10
+
11
+ # Data processing
12
+ pandas
13
+ numpy
14
+
15
+ # LLM and AI tools
16
+ langchain
17
+ langgraph
18
+ chainlit
19
+ transformers # Hugging Face Transformers
20
+ datasets # Hugging Face Datasets
21
+ torch # Required for many HF models
22
+ sentence-transformers # For embeddings
23
+
24
+ # API and utilities
25
+ python-dotenv # For environment variables
26
+ requests