https://github.com/kraptor/isocodes
ISO codes for Nim. Supports loading the data at runtime or embedding it within the executable.
https://github.com/kraptor/isocodes
countries currency iso language languages nim nim-lang scripts standards
Last synced: 16 days ago
JSON representation
ISO codes for Nim. Supports loading the data at runtime or embedding it within the executable.
- Host: GitHub
- URL: https://github.com/kraptor/isocodes
- Owner: kraptor
- License: mit
- Created: 2021-07-09T21:42:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T21:12:05.000Z (7 months ago)
- Last Synced: 2024-11-07T22:19:16.165Z (7 months ago)
- Topics: countries, currency, iso, language, languages, nim, nim-lang, scripts, standards
- Language: Nim
- Homepage:
- Size: 1.19 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nim - isocodes - ISO codes for Nim (ISO 3166-1, ISO 3166-2, ISO 3166-3, ISO 15924, ISO 15924, ISO 639-2, ISO 639-5) (Data / Standards)
README
[](https://nim-lang.org/) 
# `isocodes`
ISO codes for Nim.
Supports loading the data at runtime or embedding it within the executable
Provides the utility `isocodes_download` to download latest JSON packages when
you don't want to use the provided ones (or if they become obsolete).
By default all data is embedded within the executable. See section [Compilation flags](#compilation-flags) on how to specify the files to load/embed and how to
load the data at runtime if you need to.
## Supported ISO standards
| ISO | Description | Library type |
|-|-|-|
| ISO 3166-1 | Name of countries | `Country` |
| ISO 3166-2 | Country subdivisions | `CountrySubdivision`|
| ISO 3166-3 | Countries removed from the standard. | `RemovedCountry` |
| ISO 15924 | Language scripts | `Script` |
| ISO 4217 | Currencies | `Currency` |
| ISO 639-2 | Languages | `Language` |
| ISO 639-5 | Language Families | `LanguageFamily` |
## Example
```nim
import isocodes
if isMainModule:
for c in Country.allIt():
echo c.name
```
## API
All procedures/iterators can be accessed by using the corresponding type.
For example: `Country`.
Procedures either return an `Option[T]` object or a `seq[T]` (when multiple
values can be requested).
> **IMPORTANT**: Procedures ending in `It` return an iterator, instead of a
`seq[T]`, if you don't want to store/build a copy of the data requested.
### Country API
#### Country Attributes
The following attributes are available for each `Country` instance:
| Attribute | Description |
|-|-|
|`name` | Country name. |
|`official_name`| Official name of the country. |
|`common_name` | Common name for the country. |
|`alpha_2` | Country ISO code (2 characters).|
|`alpha_3` | Country ISO code (3 characters).|
|`numeric` | Numeric code for the country. **NOTE**: this is a string. |
|`flag` | Flag emoji for the country. |
#### Country Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of countries |
|`.all()` | `seq` for all countries. |
|`.allIt()` | Iterator for all countries. |
|`.byName(str)` | `Option[Country]` with the specified name. |
|`.byAlpha2(str)` | `Option[Country]` with the specified alpha2 code. |
|`.byAlpha3(str)` | `Option[Country]` with the specified alpha3 code. |
|`.byNumeric(str)` | `Option[Country]` with the specified numeric code. |
|`.byOfficialName(str)`| `Option[Country]` with the specified official name. |
|`.byCommonName(str)` | `Option[Country]` with the specified common name. |
|`.find(proc)` | `seq` for all countries that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all countries that proc evaluates to `true`.|
|`.findFirst(proc)` | `Option[Country]` were proc evaluates to `true`. |
### CountrySubdivision API
#### CountrySubdivision Attributes
| Attribute | Description |
|-|-|
|`code` | Subdivision code. |
|`name` | Name of the subdivision. |
|`type` | Type of the subdivision.
**NOTE**: use [stropping](https://en.wikipedia.org/wiki/Nim_%28programming_language%29#Stropping) to access this field because type is a reserved word.
Example: ``echo subdivision.`type` ``.|
|`parent` | Parent code.|
#### CountrySubdivision Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of subdivisions |
|`.all()` | `seq` for all subdivisions. |
|`.allIt()` | Iterator for all subdivisions. |
|`.byCountryCode(str)` | `seq` for subdivisions for an specific country code. |
|`.byCountryCodeIt(str)`| Iterator for subdivisions for an specific country code. |
|`.byCode(str)` | `seq` for subdivisions by specified code. |
|`.byCodeIt(str)` | Iterator for subdivisions specified by code. |
|`.byCodeStart(str)` | `seq` for subdivisions where code starts by a value. |
|`.byCodeStartIt(str)` | Iterator subdivisions where code starts by a value. |
|`.byName(str)` | `seq` for subdivisions with specified name. |
|`.byNameIt(str)` | Iterator for subdivisions with specified name. |
|`.byType(str)` | `seq` for subdivisions with the specified type. |
|`.byTypeIt(str)` | Iterator for subdivisions with the specified type. |
|`.byParent(str)` | `seq` for subdivisions with the specified parent value. |
|`.byParentIt(str)` | Iterator for subdivisions with the specified parent value. |
|`.find(proc)` | `seq` for all subdivisions that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all subdivisions that proc evaluates to `true`.|
|`.findFirst(proc)` | `Option[CountrySubdivision]` were proc evaluates to `true`. |
### RemovedCountry API
#### RemovedCountry Attributes
| Attribute | Description |
|-|-|
|`name` | Country name. |
|`official_name` | Official name of the country. |
|`alpha_2` | Country ISO code (2 characters). |
|`alpha_3` | Country ISO code (3 characters). |
|`alpha_4` | Country ISO code (4 characters). |
|`numeric` | Numeric code for the country.
**NOTE**: this is a string.|
|`comment` | Comment about the country. |
|`withdrawal_date`| Date of withdrawal (format: YYYY or YYYY-MM-DD)
**NOTE**: this is a string.|
#### RemovedCountry Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of countries |
|`.all()` | `seq` for all countries. |
|`.allIt()` | Iterator for all countries. |
|`.byName(str)` | `Option[Country]` with the specified name. |
|`.byAlpha2(str)` | `Option[Country]` with the specified alpha2 code. |
|`.byAlpha3(str)` | `Option[Country]` with the specified alpha3 code. |
|`.byAlpha4(str)` | `Option[Country]` with the specified alpha4 code. |
|`.byNumeric(str)` | `Option[Country]` with the specified numeric code. |
|`.byWithdrawalDate(str)` | `seq` for all countries with specified date. |
|`.byWithdrawalDateIt(str)`| Iterator all countries with specified date. |
|`.byWithdrawalYear(str)` | `seq` for all countries with specified year. |
|`.byWithdrawalYearIt(str)`| Iterator all countries with specified year. |
|`.find(proc)` | `seq` for all countries that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all countries that proc evaluates to `true`.|
|`.findFirst(proc)` | `Option[Country]` were proc evaluates to `true`. |
### Script API
#### Script Attributes
| Attribute | Description |
|-|-|
|`name` | Script name. |
|`alpha_4` | Script ISO code (4 characters). |
|`numeric` | Numeric code for the script.
**NOTE**: this is a string.|
#### Script Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of scripts |
|`.all()` | `seq` for all scripts. |
|`.allIt()` | Iterator for all scripts. |
|`.byName(str)` | `Option[Script]` with the specified name. |
|`.byAlpha4(str)` | `Option[Script]` with the specified alpha4 code. |
|`.byNumeric(str)` | `Option[Script]` with the specified numeric code. |
|`.find(proc)` | `seq` for all scripts that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all scripts that proc evaluates to `true`. |
|`.findFirst(proc)`| `Option[Script]` were proc evaluates to `true`. |
### Currency API
#### Currency Attributes
| Attribute | Description |
|-|-|
|`name` | Currency name. |
|`alpha_3` | Currency ISO code (3 characters). |
|`numeric` | Numeric code for the currency.
**NOTE**: this is a string.|
#### Currency Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of currencies. |
|`.all()` | `seq` for all currencies. |
|`.allIt()` | Iterator for all currencies. |
|`.byName(str)` | `Option[Currency]` with the specified name. |
|`.byAlpha3(str)` | `Option[Currency]` with the specified alpha3 code. |
|`.byNumeric(str)` | `Option[Currency]` with the specified numeric code. |
|`.find(proc)` | `seq` for all currencies that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all currencies that proc evaluates to `true`.|
|`.findFirst(proc)`| `Option[Currency]` were proc evaluates to `true`. |
### Language API
#### Language Attributes
| Attribute | Description |
|-|-|
|`name` | Language name. |
|`alpha_2` | Language ISO code (2 characters). |
|`alpha_3` | Language ISO code (3 characters). |
|`common_name` | Language common name. |
|`bibliographic` | Language bibliographic code. |
#### Language Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of languages. |
|`.all()` | `seq` for all languages. |
|`.allIt()` | Iterator for all languages. |
|`.byName(str)` | `Option[Language]` with the specified name. |
|`.byCommonName(str)` | `Option[Language]` with the specified common name. |
|`.byAlpha2(str)` | `Option[Language]` with the specified alpha2 code. |
|`.byAlpha3(str)` | `Option[Language]` with the specified alpha3 code. |
|`.byBibliographic(str)`| `Option[Language]` with the specified bibliographic code.|
|`.find(proc)` | `seq` for all languages that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all languages that proc evaluates to `true`.|
|`.findFirst(proc)` | `Option[Language]` were proc evaluates to `true`. |
### LanguageFamily API
#### LanguageFamily Attributes
| Attribute | Description |
|-|-|
|`name` | Language family name. |
|`alpha_3` | Language family ISO code (3 characters). |
#### LanguageFamily Procedures
| Procedure | Description |
|-|-|
|`.count()` | Number of language families. |
|`.all()` | `seq` for all language families. |
|`.allIt()` | Iterator for all language families. |
|`.byName(str)` | `Option[LanguageFamily]` with the specified name. |
|`.byAlpha3(str)` | `Option[LanguageFamily]` with the specified alpha3 code. |
|`.find(proc)` | `seq` for all language families that proc evaluates to `true`. |
|`.findIt(proc)` | Iterator for all language families that proc evaluates to `true`.|
|`.findFirst(proc)` | `Option[LanguageFamily]` were proc evaluates to `true`. |
## Compilation flags
With the following flags it's possible to embed the data (or not) and specify the JSON
file to embed/load. This could be useful if the provided files are outdated and you want
to provide your own files, or if you want to load the data at runtime.
| Flag | Comment |
|-|-|
| **Countries**
|`-d:embedCountries=true` | Embed countries data within the executable. |
|`-d:embedCountries=false` | Load countries data at runtime. |
|`-d:useCountriesFile=PATH` | Use a specific countries JSON file. |
| **Country Subdivisions**
|`-d:embedSubdivisions=true` | Embed subdivisions data within the executable. |
|`-d:embedSubdivisions=false` | Load subdivisions data at runtime. |
|`-d:useSubdivisionsFile=PATH` | Use a specific subdivisions JSON file. |
| **Removed Countries**
|`-d:embedRemovedCountries=true` | Embed removed countries data within the executable.|
|`-d:embedRemovedCountries=false` | Load removed countries data at runtime. |
|`-d:useRemovedCountriesFile=PATH`| Use a specific removed countries JSON file. |
| **Scripts**
|`-d:embedScripts=true` | Embed scripts data within the executable.|
|`-d:embedScripts=false` | Load scripts data at runtime. |
|`-d:useScriptsFile=PATH`| Use a specific scripts JSON file. |
| **Currencies**
|`-d:embedCurrencies=true` | Embed currencies data within the executable.|
|`-d:embedCurrencies=false` | Load currencies data at runtime. |
|`-d:useCurrenciesFile=PATH`| Use a specific currencies JSON file. |
| **Language**
|`-d:embedLanguages=true` | Embed languages data within the executable.|
|`-d:embedLanguages=false` | Load languages data at runtime. |
|`-d:useLanguagesFile=PATH`| Use a specific languages JSON file. |
| **Language Families**
|`-d:embedLanguageFamilies=true` | Embed language families data within the executable.|
|`-d:embedLanguageFamilies=false` | Load language families data at runtime. |
|`-d:useLanguageFamiliesFile=PATH`| Use a specific language families JSON file. |
## Source
The ISO codes JSON files are synced verbatim from Debian's `iso-codes`
repository here:
-