Metadata-Version: 2.1
Name: earthcube-utilities
Version: 0.1.11
Summary: A package of utilities for NSF Earthcube Geocodes Project
Author-email: Mike Bobak <mbobak@illinois.edu>, David Valentine <dwvalentine@ucsd.edu>
Maintainer-email: Mike Bobak <mbobak@illinois.edu>, David Valentine <dwvalentine@ucsd.edu>
Project-URL: Homepage, https://www.earthcube.org/
Project-URL: Bug Tracker, https://github.com/earthcube/earthcube_utilities/issues
Project-URL: Geocodes Documentation, https://earthcube.github.io/geocodes_documentation/
Project-URL: Source, https://github.com/earthcube/earthcube_utilities
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Earthcube Utilities



## Proposed use
### Earthcube Utilities:
https://pypi.org/project/earthcube-utilities/


### Manual Install
`python3 -m pip install  earthcube-utilities`



## Developers

### scripts
In theory, if pip installed, theree is one script at present,
`generaterepostats --graphendpoint https://graph.geocodes-dev.earthcube.org/blazegraph/namespace/earthcube/ -s3 localhost:9000 --s3bucket gleaner`

from [console scripts](https://setuptools.pypa.io/en/latest/userguide/entry_point.html#console-scripts)

### local development mode
```shell
cd earthcube_utiltiies
pip3 install -e .
```
## Developement

create a virutal env and activate

`source {envname}/bin/activate`


use editable install

```shell
cd earthcube_utiltiies
pip3 install -e .
```

If you edit the pyproject.toml and want to test an added script, 
```shell
cd summarize
pip3 uninstall -e earthcube_utiltiies
pip3 install -e .
```

## building a test package

### test packaging
Locally,  see if a package builds
`python3 -m pip install build`

in _build/lib_ you can see what files are included in package

### build a wheel
to see what is added to a package, 

`python -m build --wheel`

_dist_ directory will contain the package. This is actually a zip file so unzip to see 
what got included

## Planning:
The planned functionality will be found in the docs folder,
[Earthcube Utilities Functionality](./docs/earthcube_utilties_functionality.md)
