init main repository

Author: wasin-waeosri

.github/copilot-instructions.md

@@ -0,0 +1,118 @@
+# Data Library - Project Setup Guide
+
+## Overview
+
+A step-by-step Copilot guide to set up a [Data Library for Python](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python) development environment with Python and JupyterLab on Windows and macOS.
+
+## Prerequisites
+
+- Python 3.11 or higher installed and available on your `PATH`
+- Git installed and configured
+- Network access to PyPI (or a trusted mirror)
+
+## Working Directory (Important)
+
+Run all commands in this guide from the **workspace root** folder.
+
+## Expected Project Layout
+
+Before running setup commands, confirm the project structure should match this layout:
+
+```text
+/
+├── .github/
+│   └── copilot-instructions.md
+├── .gitignore
+├── images/
+├── LICENSE.md
+├── README.md
+├── requirements.txt
+├── .venv/
+└── notebook/
+    ├── ld_notebook_async.ipynb
+    ├── .env
+    ├── .env.example
+    └── lseg-data.config.json
+```
+
+Notes:
+- `.venv/` must be inside the workspace root.
+- `notebook/` must contain both `ld_notebook_async.ipynb` and `lseg-data.config.json`.
+
+---
+
+## Part 1: Check the minimum project file requirements
+
+1. Check if the following files and folders are present in the workspace root and have content:
+
+   - `README.md`
+   - `LICENSE.md`
+   - `.gitignore` (must include `.venv/` and `notebook/.env` entries)
+   - `images/` (folder must exist)
+   - `notebook/` (folder must exist)
+   - `requirements.txt` (must exist)
+   - `notebook/.env.example` (must exist)
+   - `notebook/lseg-data.config.json` (must exist)
+
+---
+
+## Part 2: Set Up the Python Virtual Environment
+
+> **Prerequisite:** The Part 1 must be completed
+
+1. Create a virtual environment named `.venv` inside the workspace root (same command on all platforms):
+
+   ```bash
+   python -m venv .venv
+   ```
+
+   This must create `.venv` at the workspace root.
+
+2. Activate the environment:
+
+   - **Windows (PowerShell):**
+     ```powershell
+     .\.venv\Scripts\Activate.ps1
+     ```
+   - **Windows (CMD):**
+     ```cmd
+     .venv\Scripts\activate.bat
+     ```
+   - **macOS / Linux:**
+     ```bash
+     source .venv/bin/activate
+     ```
+
+3. Update pip to the latest version:
+
+   - **Windows (PowerShell/CMD):**
+     ```powershell
+     python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --no-cache-dir --upgrade pip
+     ```
+   - **macOS:**
+     ```bash
+     python3 -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --no-cache-dir --upgrade pip
+     ```
+
+4. Install the required packages:
+
+   - **Windows (PowerShell/CMD):**
+     ```powershell
+     python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --no-cache-dir -r requirements.txt
+     ```
+   - **macOS:**
+     ```bash
+     python3 -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --no-cache-dir -r requirements.txt
+     ```
+
+5. Verify the installation succeeded:
+
+   - **Windows (PowerShell/CMD):**
+     ```powershell
+     python -c "import lseg.data; print('lseg-data installed successfully')"
+     ```
+   - **macOS:**
+     ```bash
+     python3 -c "import lseg.data; print('lseg-data installed successfully')"
+     ```
+---

.gitignore

@@ -0,0 +1,138 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject.db
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Virtual environment
+.venv/
+
+# Notebook environment secrets
+notebook/.env
+notebook/test*
+notebook/test_console*
+note.md
+# for development purposes, ignore these notebooks
+notebook/ld_get_data_async.ipynb
+notebook/ld_notebook_async_taskgroup.ipynb 
+notebook/ld_notebook_gather_performance.ipynb
+notebook/ld_notebook_taskgroup_performance.ipynb 
+notebook/test_notebook.ipynb