Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steinrobert/python-restcountries
Python wrapper for http://restcountries.com
https://github.com/steinrobert/python-restcountries
Last synced: 9 days ago
JSON representation
Python wrapper for http://restcountries.com
- Host: GitHub
- URL: https://github.com/steinrobert/python-restcountries
- Owner: SteinRobert
- License: unlicense
- Created: 2016-09-11T12:21:35.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2022-10-10T18:24:27.000Z (about 2 years ago)
- Last Synced: 2024-09-18T02:27:33.137Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 58.6 KB
- Stars: 78
- Watchers: 3
- Forks: 32
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
python-restcountries
====================
------
[](https://github.com/psf/black)
[](https://coveralls.io/github/SteinRobert/python-restcountries?branch=master)
[](https://badge.fury.io/py/python-restcountries)
This is a simple python wrapper for the API of [http://restcountries.com](http://restcountries.com).
If there are any issues, please use this repository to contact me about it.
Installation
------------
```shell
pip install python-restcountries
```
Usage
-----
Just import the API Wrapper and start using it!::
```python
from restcountries import RestCountryApiV2 as rapi
def foo(name):
country_list = rapi.get_countries_by_name('France')
```
Response filtering
------------------
Pass filters as a keyword argument to any of RestCountryApiV2 or RestCountryApi methods,
this filters the response returned by the api. Thus the Country Object will only contain the attributes in the
filters list.
```python
from restcountries import RestCountryApiV2 as rapi
def foo(name):
country_list = rapi.get_countries_by_name("France" ,filters=["name","currencies","capital"])
```
Attributes that can be passed in the filters list.
-------------------------------------------------
- topLevelDomain
- alpha2Code
- alpha3Code
- currencies
- capital
- callingCodes
- altSpellings
- relevance
- region
- subregion
- translations
- population
- latlng
- demonym
- area
- gini
- timezones
- borders
- nativeName
- name
- numericCode
- languages
- flag
- regionalBlocs
- cioc
The Country object
------------------
The API returns Country objects or a list of Country objects. Through the country objects one is able to
access following attributes.
```python
country = country_list[0]
print(country.name)
France
```
- top_level_domain
- alpha2_code
- alpha3_code
- currencies
- capital
- calling_codes
- alt_spellings
- relevance
- region
- subregion
- translations
- population
- latlng
- demonym
- area
- gini
- timezones
- borders
- native_name
- name
- numeric_code
- languages
- flag
- regional_blocs
- cioc