Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allansifuna/flask-restcountries
A restcountries.eu API package for Flask Applications
https://github.com/allansifuna/flask-restcountries
allansifuna flask flask-restcountries github-actions pypi python
Last synced: 3 days ago
JSON representation
A restcountries.eu API package for Flask Applications
- Host: GitHub
- URL: https://github.com/allansifuna/flask-restcountries
- Owner: allansifuna
- License: mit
- Created: 2021-03-25T14:29:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-12T08:41:56.000Z (almost 3 years ago)
- Last Synced: 2024-08-08T20:17:33.110Z (about 2 months ago)
- Topics: allansifuna, flask, flask-restcountries, github-actions, pypi, python
- Language: Python
- Homepage: https://restcountries.com/
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.codacy.com/manual/allansifuna/Flask-RestCountries?utm_source=github.com&utm_medium=referral&utm_content=allansifuna/Flask-RestCountries&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/allansifuna/Flask-RestCountries?branch=main)
# Flask-RestCountries
[Flask-RestCountries](https://pypi.org/project/Flask-RestCountries/) provides a simple intergration for [restcountries.com](https://restcountries.com) API with Flask Applications.
# Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install flask-restcountries.
```bash
pip install Flask-RestCountries
```
# Usage
```python
from flask import Flask
from flask_restcountries import CountriesAPI
app = Flask(__name__)
rapi = CountriesAPI(app)
```
# if you are using blueprints
```python
from flask_restcountries import CountriesAPI
rapi = CountriesAPI()
rapi.init_app(app)
```
## Usage in App
```python
@app.route('/get-all')
def get_all_countries():
"""all_countries is a list of Country Objects"""
all_countries = rapi.get_all()
return render_template("example.html", all_countries=all_countries)
```
## Other Useful Methods
### Get Countries By Calling Code string of a country. E.g. '254'.
```python
countries=rapi.get_countries_by_calling_code("+254")
```
### Get a Country By Alpha code string of a country. E.g. 'ke'.
```python
countries=rapi.get_country_by_country_code("ke")
```
### Get Countries By Capital string of a country. E.g. 'Nairobi'
```python
countries=rapi.get_countries_by_capital("Nairobi")
```
### Get Countries By Currency string of a country. E.g. 'KES'.
```python
countries=rapi.get_countries_by_currency("KES")
```
### Get Countries By Language string of a country. E.g. 'sw'.
```python
countries=rapi.get_countries_by_language("sw")
```
### Get Countries By Name string of a country. E.g. 'Kenya'.
```python
countries=rapi.get_countries_by_name("Kenya")
```
### Get Countries By Region string of a country. E.g. 'Africa'.
```python
countries=rapi.get_countries_by_region("Africa")
```
### Get Countries By Subregion string of a country. E.g. 'Eastern Africa'
```python
countries=rapi.get_countries_by_subregion("Eastern Africa")
```
## Response Filtering
To make the response return only afew selected fields, you can filter the response by passing a list
of field to be returned in the filters keyword as a kwarg to the methods above. ie:-
```python
countries=rapi.get_countries_by_calling_code("+254",filters=["name","currencies","capital"])
```
## Attributes that can be passed to the filters keyword
- 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
## Attributes of the Country object returned per each request
- 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
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
# License
[MIT](https://github.com/allansifuna/Flask-RestCountries/blob/main/LICENSE)