Metadata-Version: 2.1
Name: statadict
Version: 1.1.0
Summary: Utility for parsing Stata dictionary files for usage with Pandas.
Home-page: https://github.com/atudomain/statadict
Author: Adrian Tuzimek
Author-email: tuziomek@gmail.com
License: UNKNOWN
Keywords: pandas,stata,dictionary,parse,import
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Description-Content-Type: text/markdown

# statadict
[![pipeline](https://gitlab.com/atudomain/statadict/badges/main/pipeline.svg)](https://gitlab.com/atudomain/statadict/-/tree/main)
[![Documentation Status](https://readthedocs.org/projects/statadict/badge/?version=main)](https://statadict.readthedocs.io/en/main/?badge=main)

Small package that allows reading Stata dictionary files (usually .dct extension).

Extracted information can be used with Pandas when calling read_fwf() function.

# Setup

To install package locally:
```
python3 -m pip install statadict --user
```
Or directly from repository:
```
make all
python3 -m pip install . --user 
```

# Usage

Having Stata dictionary file and related fixed width field csv file without headers, you can now use Pandas to read data:
```
import pandas as pd
from statadict import parse_stata_dict

stata_dict = parse_stata_dict(file="dictionary-file.dct")
data = pd.read_fwf("related-fwf-file.dat", names=stata_dict.names, colspecs=stata_dict.colspecs)
```


