Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/navinpeiris/countriex
All sorts of useful information about every country. A pure elixir port of the ruby Countries gem
https://github.com/navinpeiris/countriex
countries country-data elixir
Last synced: 7 days ago
JSON representation
All sorts of useful information about every country. A pure elixir port of the ruby Countries gem
- Host: GitHub
- URL: https://github.com/navinpeiris/countriex
- Owner: navinpeiris
- License: mit
- Created: 2016-11-01T05:49:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-11T11:51:28.000Z (over 5 years ago)
- Last Synced: 2024-10-01T12:21:07.005Z (about 1 month ago)
- Topics: countries, country-data, elixir
- Language: Elixir
- Size: 79.1 KB
- Stars: 31
- Watchers: 3
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A pure elixir country data provider containing various information for every country in ISO 3166. (Miscellaneous)
- fucking-awesome-elixir - countriex - A pure elixir country data provider containing various information for every country in ISO 3166. (Miscellaneous)
- awesome-elixir - countriex - A pure elixir country data provider containing various information for every country in ISO 3166. (Miscellaneous)
README
# Countriex
[](https://travis-ci.org/navinpeiris/countriex)
[](https://hex.pm/packages/countriex)
[](https://hex.pm/packages/countriex)
[](https://beta.hexfaktor.org/github/navinpeiris/countriex)
[](http://doge.mit-license.org)
A pure elixir port of the ruby [countries](https://github.com/hexorx/countries) gem that provides all sorts of useful information about every country packaged as convenient little country structs. It includes data from ISO 3166 (countries and states/subdivisions), ISO 4217 (currency), and E.164 (phone numbers).
## Installation
Add `countriex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:countriex, "~> 0.4"}]
end
```
## Usage
To get all country information:
```elixir
Countriex.all
```
The `get_by/2` method can be used to retrieve the first matching country for any given criteria, for example:
```elixir
Countriex.get_by(:alpha2, "US") # %Countriex.Country{name: "United States of America", alpha2: "US", alpha3: "USA", ...}
Countriex.get_by(:name, "United Kingdom") # %Countriex.Country{alpha2: "GB", alpha3: "GBR", ...}
```
The `filter/2` method can be used to retrieve all countries matching the given criteria:
```elixir
Countriex.get_by(:region, "Oceania") # [%Countriex.Country{name: "Kiribati", ...}, %Countriex.Country{name: "American Samoa", ...}, ...]
Countriex.get_by(:eu_member, true) # [%Countriex.Country{name: "Luxembourg", ...}, %Countriex.Country{name: "Poland", ...}, ...]
```
See the fields in the `Countriex.Country` struct for all possible field names that can be used for the above methods.
## Development
### Regenerating country data
Run the following mix task to re-generate the country data.
```
mix countriex.generate_data
```
## License
The MIT License
Copyright (c) 2016-present Navin Peiris
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.