Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
diversemix committed Aug 19, 2024
1 parent abde35c commit f254de1
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
14 changes: 12 additions & 2 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## Install pyenv

```bash

# Install pyenv
curl https://pyenv.run | bash

Expand All @@ -23,7 +22,6 @@ pyenv local 3.10.14
## Install poetry

```bash

# Install poetry
curl -sSL https://install.python-poetry.org | python3 -

Expand All @@ -34,3 +32,15 @@ export PATH="$HOME/.local/bin:$PATH"
cd say_hello
poetry install
```

## Building

```bash
make build
```

## Testing

```bash
make test
```
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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-<version>-py3-none-any.whl
```

Goto the [releases page](https://github.com/climatepolicyradar/gcf-data-mapper/releases)
to find the latest version.

## Usage

TBD

0 comments on commit f254de1

Please sign in to comment.