Metadata-Version: 2.4
Name: city-macro-data
Version: 0.1.0
Summary: City macro dataset distributed as a Python package.
Author: Data Team
License-Expression: MIT
Project-URL: Homepage, https://example.com/MinjieDING/city-macro-data
Project-URL: Repository, https://example.com/MinjieDING/city-macro-data-repo
Project-URL: Issues, https://example.com/MinjieDING/city-macro-data/issues
Keywords: city,macro,dataset,economics,china
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.0
Requires-Dist: openpyxl>=3.1.5

# city-macro-data

`city-macro-data` is a distributable dataset package for city-level macro data.

## Installation

```bash
pip install city-macro-data
```

## Quick Start

```python
from city_macro_data import load_data, get_metadata, data_version, validate_data

df = load_data()
meta = get_metadata()

print(df.shape)
print(data_version())
print(validate_data())
```

## API

- `load_data()`: return dataset as `pandas.DataFrame`
- `get_metadata()`: return metadata from `metadata.json`
- `data_version()`: return dataset version string
- `validate_data(required_columns=None)`: validate non-empty data and required columns

## Data Update Workflow (for maintainers)

From repository root:

```bash
python build-data/build_data.py
powershell -ExecutionPolicy Bypass -File scripts/sync_packages.ps1
python -m pip install --force-reinstall .\python-pkg
```

## Notes for Windows Users

Avoid editable install (`pip install -e`) under non-ASCII paths. Use normal install:

```bash
python -m pip install .\python-pkg
```
