Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dc-almeida committed Sep 3, 2024
1 parent 4a32b09 commit cdf7e91
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,21 @@ parameters and the values to search as shown below:

>>> pysquirrel.nuts.get(country_code="AT") # gets all regions in Austria

>>> pysquirrel.nuts.get(code="PT191") # gets the PT191 region

>>> pysquirrel.nuts.get(label="Drenthe") # gets the Drenthe region

>>> pysquirrel.nuts.get(level=3) # gets all NUTS3 regions

>>> pysquirrel.nuts.get(parent_code="DE2") # gets all regions whose parent region is DE2
>>> pysquirrel.nuts.get(country_code="AT", level=3) # gets all NUTS3 regions in Austria
```

Each Region object consists of five attributes: a NUTS code (e.g.: AT127), a country
code, a label (the full region name), a NUTS level (1, 2 or 3), and a parent code
(corresponding to the NUTS parent region).

## Eurostat copyright notice on NUTS region data file

This package imports the NUTS spreadsheet from the Eurostat website.

## Eurostat copyright notice

Please note that pysquirrel is not developed, maintained or affiliated
with Eurostat. The [Eurostat copyright notice
applies](https://ec.europa.eu/eurostat/web/main/help/copyright-notice).
Expand Down

0 comments on commit cdf7e91

Please sign in to comment.