diff --git a/DEVELOPER.md b/DEVELOPER.md index 6c5f5f6..8fc7261 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -3,7 +3,6 @@ ## Install pyenv ```bash - # Install pyenv curl https://pyenv.run | bash @@ -23,7 +22,6 @@ pyenv local 3.10.14 ## Install poetry ```bash - # Install poetry curl -sSL https://install.python-poetry.org | python3 - @@ -34,3 +32,15 @@ export PATH="$HOME/.local/bin:$PATH" cd say_hello poetry install ``` + +## Building + +```bash +make build +``` + +## Testing + +```bash +make test +``` diff --git a/README.md b/README.md index 07bbc6c..0ba0af1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ # gcf-data-mapper + A CLI tool to map the GCF data to the required JSON format for bulk-import. -*Developers* please read the [DEVELOPERS.md](DEVELOPERS.md) file for more information. +- _Developers_ please read the [DEVELOPERS.md](DEVELOPERS.md) file for more information. + +- This tool is designed to map this [GCF data](https://drive.google.com/drive/folders/1FBia9JzpdaCjRe7M7-pgh3Ahl9_MReh_) ## Installation This package is not available on PyPI. To install it, you need to build the package and install it locally. ```bash -poetry build +make build pip install dist/gcf_data_mapper--py3-none-any.whl ``` + +Goto the [releases page](https://github.com/climatepolicyradar/gcf-data-mapper/releases) +to find the latest version. + +## Usage + +TBD