ghostconfig 0.1.0__tar.gz

ghostconfig-0.1.0/.cursor/rules/python-file-structure.mdc

@@ -0,0 +1,68 @@
+---
+description: Python file structure and declaration order
+globs: **/*.py
+alwaysApply: true
+---
+
+# File Structure: Top-Down Readability
+
+Structure Python files so a reader sees the **main idea first**. Put the primary entry point, class, or function at the top, and helpers below. This mirrors how you'd explain the code to someone — start with the high-level concept, then reveal the details.
+
+```python
+# ✅ GOOD — main idea first, helpers below
+
+def process_data(path: str):
+    data = load_data(path)
+    result = compute_results(data)
+    print(result)
+
+
+def load_data(path: str):
+    ...
+
+
+def compute_results(data):
+    ...
+```
+
+```python
+# ❌ BAD — reader must scroll to the bottom to understand the purpose
+
+def load_data(path: str):
+    ...
+
+
+def compute_results(data):
+    ...
+
+
+def process_data(path: str):
+    data = load_data(path)
+    result = compute_results(data)
+    print(result)
+```
+
+## Ordering Rules
+
+1. **Imports** — standard library, third-party, local (as usual)
+2. **Constants / module-level config**
+3. **Primary class or function** — the main concept of this file
+4. **Supporting classes and functions** — in order of first use from above
+5. **`if __name__ == "__main__"` block** — at the very bottom
+
+## Classes
+
+The same principle applies within a class: put the most important public methods first, then private/helper methods below.
+
+```python
+class Trainer:
+    def train(self):          # ← main idea
+        self._load_data()
+        self._run_loop()
+
+    def _load_data(self):     # ← helpers below
+        ...
+
+    def _run_loop(self):
+        ...
+```

ghostconfig-0.1.0/.cursor/rules/python-imports.mdc

@@ -0,0 +1,41 @@
+---
+description: Python import style — import modules, not names
+globs: **/*.py
+alwaysApply: false
+---
+
+# Import Style: Import Modules, Not Names
+
+Import at the module level, then reference names through the module. This makes it immediately clear where any class or function comes from when reading the code.
+
+```python
+# ❌ BAD — names imported directly, origin is lost at the call site
+from src.tokenizer import Tokenizer
+from src.model import VisionEncoder, TextDecoder
+from src.dataset import ImageCaptionDataset
+
+tokenizer = Tokenizer(config)
+encoder = VisionEncoder(config)
+
+# ✅ GOOD — module imported, origin is visible at the call site
+from src import tokenizer as tokenizer_module
+from src import model as model_module
+from src import dataset as dataset_module
+
+tokenizer = tokenizer_module.Tokenizer(config)
+encoder = model_module.VisionEncoder(config)
+dataset = dataset_module.ImageCaptionDataset(config)
+```
+
+## Exceptions
+
+Standard library and well-known third-party modules where the source is universally understood may be imported directly:
+
+```python
+# These are fine
+import torch
+import numpy as np
+import lightning as L
+import pathlib
+import dataclasses
+```

ghostconfig-0.1.0/.cursor/rules/python-naming.mdc

@@ -0,0 +1,68 @@
+---
+description: Python naming conventions — full words, no abbreviations
+globs: **/*.py
+alwaysApply: true
+---
+
+# Naming Conventions: Prefer Full Words
+
+Use long, descriptive names. A reader should understand what a variable holds or what a function does without any surrounding context. Avoid abbreviations and acronyms unless they are universally understood (e.g. `url`, `id`).
+
+## Variables
+
+```python
+# ❌ BAD
+img = load(p)
+hist = compute_hist(img)
+res = run(cfg)
+
+# ✅ GOOD
+image = load_image(path)
+image_histogram = compute_image_histogram(image)
+result = run_training(config)
+```
+
+## Functions
+
+```python
+# ❌ BAD
+def proc_img(p): ...
+def calc_loss(pred, tgt): ...
+def get_cfg(): ...
+
+# ✅ GOOD
+def process_image(path): ...
+def calculate_loss(prediction, target): ...
+def load_config(): ...
+```
+
+## Allowed Short Names
+
+Only use single-letter or abbreviated names for:
+
+- Loop indices: `i`, `j`, `k`
+- Math coordinates: `x`, `y`, `z`
+- Throwaway unpacking: `_`
+
+```python
+for i, image in enumerate(images):
+    ...
+
+x, y, z = position
+```
+
+## Common Substitutions
+
+| ❌ Avoid | ✅ Use instead |
+|----------|----------------|
+| `img` | `image` |
+| `cfg` | `config` |
+| `res` / `ret` | `result` |
+| `pred` | `prediction` |
+| `tgt` | `target` |
+| `src` | `source` |
+| `dst` | `destination` |
+| `buf` | `buffer` |
+| `num_` prefix | `count_` or spell out (e.g. `number_of_epochs`) |
+| `tmp` | `temporary_...` or a descriptive name |
+| `p` / `fp` | `path` / `file_path` |

ghostconfig-0.1.0/.cursor/rules/python-tests.mdc

@@ -0,0 +1,68 @@
+---
+description: Python testing conventions — pytest, colocated tests, fixtures
+globs: **/*_test.py
+alwaysApply: false
+---
+
+# Testing Conventions
+
+## File Location
+
+Place test files next to the file they test, using the `_test.py` suffix:
+
+```
+dataset.py
+dataset_test.py
+
+model.py
+model_test.py
+
+trainer.py
+trainer_test.py
+```
+
+## Use `@pytest.fixture` Instead of Test Classes
+
+```python
+# ❌ BAD — unittest-style classes
+class TestDataset(unittest.TestCase):
+    def setUp(self):
+        self.dataset = Dataset("data/train")
+
+    def test_length(self):
+        self.assertEqual(len(self.dataset), 100)
+
+# ✅ GOOD — fixtures
+@pytest.fixture
+def training_dataset():
+    return Dataset("data/train")
+
+def test_dataset_length(training_dataset):
+    assert len(training_dataset) == 100
+```
+
+## Use `@pytest.mark.parametrize` for Multiple Scenarios
+
+```python
+# ❌ BAD — duplicated test functions
+def test_normalise_zero():
+    assert normalise(0.0) == 0.0
+
+def test_normalise_one():
+    assert normalise(255.0) == 1.0
+
+# ✅ GOOD — parametrized
+@pytest.mark.parametrize("pixel_value, expected", [
+    (0.0,   0.0),
+    (255.0, 1.0),
+    (127.5, 0.5),
+])
+def test_normalise_pixel(pixel_value, expected):
+    assert normalise(pixel_value) == expected
+```
+
+## General Rules
+
+- Use plain `assert` statements — no `assertEqual`, `assertTrue`, etc.
+- Name tests `test_<what it does>`, not `test_<function name>`
+- Keep each test focused on one behaviour

ghostconfig-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml