Metadata-Version: 2.1
Name: un-treaties
Version: 0.1.2
Summary: Push countries to ratify UN treaties
Home-page: https://github.com/DataForGood-Norway/un_treaties
Author: Data For Good - Norway
Author-email: contact@dataforgood.no
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4
Requires-Dist: connexion
Requires-Dist: html5lib
Requires-Dist: lxml
Requires-Dist: pandas
Requires-Dist: pycountry
Requires-Dist: requests

# United Nations Treaties

This package is for crawling and presenting data from the [UN Treaties web site](https://treaties.un.org/).


## Crawling the website hosting the UN Treaties

Use the command

```shell
$ un_crawl
```

This will crawl the UN Treaties web site and cache the files it downloads
locally in a `.un_treaties` directory inside your home directory.

If you need to refresh the cache you can run it with:

`un_crawl --no-cache`


## Run a Rest API locally to interact with the data

To start serving data at [http://localhost:5000](http://localhost:5000), simply do:

```shell
$ un_serve
```



