About The Project
pycountries provides the ISO enums for the standards:
pycountries can be used natively with pydantic >= 1.5 and python >= 3.8.
It makes really easy to use fastapi and other related libraries.
Requirements
- Python >= 3.8
Installation
pip install pycountries
Usage
Examples show how to use pycountries with pydantic + fastapi, but
you can use it with pydantic and any other libraries.
pip install fastapi
pip install pycountries
When you have all required libraries you can quickstart with this code:
from decimal import Decimal
from fastapi import FastAPI
from pycountries import Country, Currency, Language
from pydantic import BaseModel, model_validator
app = FastAPI()
class IndexRequest(BaseModel):
country: Country
currency: Currency
amount: Decimal
language: Language
@model_validator(mode="after")
def validate_amount(self) -> "IndexRequest":
self.amount = self.currency.clean_amount(self.amount)
return self
class IndexResponse(BaseModel):
amount: Decimal
@app.post("/")
async def root(data: IndexRequest):
return IndexResponse(**data.model_dump())
Request Examples
curl -X POST -H "Content-Type: application/json" -d '{"country":"US", "currency":"USD", "amount":"20.20", "language":"eng"}' http://127.0.0.1:8000
{"amount":"20.20"}
curl -X POST -H "Content-Type: application/json" -d '{"country":"US", "currency":"USD", "amount":"-20.20", "language":"eng"}' http://127.0.0.1:8000
Internal Server Error
Phones
I'm still not sure about the logic, if you have any ideas please create a task
here.
The problem here is that calling code is not unique per country. For example,
at least 3 countries have code +1: United States, Canada, Barbados. To determine the country
we need to see a prefix - N numbers after country code. And, looks like these prefixes are quite
dynamic, so should be managed accordingly.
For now logic is:
- Return first calling code match if prefix is not provided.
- If prefix is provided return first prefix match, or first "candidate" if there are no exact prefix matches.
It is very useful if you want to show phone dynamically. See an example below for more info.
from pycountries import Phone
Phone(1)
Phone("1")
Phone("+1")
Phone(1, prefix=3)
Phone(1, prefix=32)
Phone(1, prefix=325)
Motivation
There is a great library pycountry, but it is incompatible with enums,
for sure enums can be generated dynamically, but python does not work good with dynamic enums, for example, you can not
inherit from enums, annotations will be broken, etc. pycountries solves these issues and more.
Soon pycountries will be providing other ISO standards related to countries.
Development
python3.12 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
Contributing
- Fork the Project
- Open a Pull Request
- Or just read here: contributing
(back to top)
Methodology
- Do a lot, break a lot.
- There are no difficult tasks, only interesting.
- Mostly TBD.
(back to top)
Important
- Quality.
- Security.
- Google first.
(back to top)
License
Distributed under the MIT License. See LICENSE.md for more information.
(back to top)
Buy me a coffee if you want to support me
https://www.buymeacoffee.com/aivCoffee
Contact
Hi all,
How are you? Hope You've enjoyed the project.
There are my contacts:
Project Link: https://github.com/koldakov/pycountries
Best regards,
Ivan Koldakov
Visitor counter