@geomelon/cameroon 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ATTRIBUTION.md +5 -0
- package/CHANGELOG.md +6 -0
- package/LICENSE +14 -0
- package/README.md +71 -2
- package/data.json +1 -0
- package/index.d.ts +3 -0
- package/index.js +4 -0
- package/package.json +34 -3
package/ATTRIBUTION.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Attribution
|
|
2
|
+
|
|
3
|
+
This data is released under [CC0 1.0](./LICENSE) — no attribution is legally required.
|
|
4
|
+
|
|
5
|
+
If you use it, a link back to [geomelon.dev](https://geomelon.dev) is appreciated but never required, the same posture Geomelon itself takes toward [Wikidata](https://www.wikidata.org), the ultimate source of this data.
|
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
Creative Commons Legal Code
|
|
2
|
+
|
|
3
|
+
CC0 1.0 Universal
|
|
4
|
+
|
|
5
|
+
CC0 is a public domain dedication. To the extent possible under law, the
|
|
6
|
+
author(s) have dedicated all copyright and related and neighboring rights to
|
|
7
|
+
this data to the public domain worldwide. This work is published from a
|
|
8
|
+
jurisdiction that recognizes the right to make dedications of copyright in
|
|
9
|
+
the same manner as if it were a public domain work.
|
|
10
|
+
|
|
11
|
+
You can copy, modify, distribute and perform the work, even for commercial
|
|
12
|
+
purposes, all without asking permission.
|
|
13
|
+
|
|
14
|
+
Full legal text: https://creativecommons.org/publicdomain/zero/1.0/legalcode
|
package/README.md
CHANGED
|
@@ -1,3 +1,72 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @geomelon/cameroon
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
City, region, and country data for **Cameroon** — 5098 cities across 12 regions, with names translated into 50 languages, sourced from Wikidata.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @geomelon/cameroon
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
const cameroon = require('@geomelon/cameroon')
|
|
15
|
+
|
|
16
|
+
cameroon.cities({ name: '<your search prefix>' }) // matches the primary name or any translation
|
|
17
|
+
cameroon.cities({ minPopulation: 1000000 })
|
|
18
|
+
cameroon.city('Q1492') // by Geomelon id or Wikidata id
|
|
19
|
+
cameroon.regions({ name: '<your search prefix>' })
|
|
20
|
+
cameroon.country // country-level fields
|
|
21
|
+
cameroon.meta // generatedAt, recordCount, license, source
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Filters
|
|
25
|
+
|
|
26
|
+
`cities(filter?)`:
|
|
27
|
+
| field | type | matches |
|
|
28
|
+
|---|---|---|
|
|
29
|
+
| `name` | `string` | case-insensitive prefix match against the primary name and every translation |
|
|
30
|
+
| `regionId` | `string` | exact match |
|
|
31
|
+
| `minPopulation` / `maxPopulation` | `number` | inclusive range |
|
|
32
|
+
| `language` | `string` | city has a translation in this language |
|
|
33
|
+
| `settlementType` | `string` | exact match against one of the city's settlement types |
|
|
34
|
+
| `limit` | `number` | caps the result count |
|
|
35
|
+
|
|
36
|
+
`regions(filter?)` supports `name` and `limit`.
|
|
37
|
+
|
|
38
|
+
## Languages
|
|
39
|
+
|
|
40
|
+
Names are translated into: Afrikaans (`af`), Albanian (`sq`), Arabic (`ar`), Armenian (`hy`), Azerbaijani (`az`), Bangla (`bn`), Basque (`eu`), Bokmål (`nb`), Bulgarian (`bg`), Catalan (`ca`), Chinese (`zh`), Croatian (`hr`), Czech (`cs`), Danish (`da`), Dutch (`nl`), English (`en`), Estonian (`et`), Finnish (`fi`), French (`fr`), Galician (`gl`), Georgian (`ka`), German (`de`), Hebrew (`he`), Hindi (`hi`), Hungarian (`hu`), Indonesian (`id`), Italian (`it`), Japanese (`ja`), Kazakh (`kk`), Korean (`ko`), Latvian (`lv`), Lithuanian (`lt`), Malay (`ms`), Modern Greek (`el`), Mongolian (`mn`), Persian (`fa`), Polish (`pl`), Portuguese (`pt`), Romanian (`ro`), Russian (`ru`), Serbian (`sr`), Slovak (`sk`), Slovene (`sl`), Spanish (`es`), Swedish (`sv`), Thai (`th`), Turkish (`tr`), Ukrainian (`uk`), Uzbek (`uz`), Vietnamese (`vi`).
|
|
41
|
+
|
|
42
|
+
Coverage is capped to the 50 languages above — a widely-spoken top-50 set plus Cameroon's own official language(s) — to keep package size reasonable. The full long tail of rarer Wikidata-only translations isn't included.
|
|
43
|
+
|
|
44
|
+
The raw JSON is still available directly if you'd rather roll your own queries:
|
|
45
|
+
```js
|
|
46
|
+
const data = require('@geomelon/cameroon/data.json')
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## FAQ
|
|
50
|
+
|
|
51
|
+
**Q: I want live geographical city data with multiple translations available, where do I get that from?**
|
|
52
|
+
Use the Geomelon API — a live, searchable database of cities, countries, and regions — see the [API Docs](https://geomelon.dev/api-docs/) or try it on [RapidAPI](https://rapidapi.com/hom3chuk/api/geomelon).
|
|
53
|
+
|
|
54
|
+
**Q: I want geo data on all countries, where do I get that?**
|
|
55
|
+
For other countries as static npm packages, see the growing list at [Data Packages](https://geomelon.dev/data-packages/). If you want every country in one place right now instead of installing packages one at a time, use the [Geomelon API](https://geomelon.dev/api-docs/).
|
|
56
|
+
|
|
57
|
+
**Q: I need a simple way to implement city autocomplete in multiple languages, how do I do that?**
|
|
58
|
+
Use the [Geomelon Free City Autocomplete API](https://geomelon.dev/free-city-autocomplete-api/) — keyless, prefix search, pre-built for this exact use case.
|
|
59
|
+
|
|
60
|
+
**Q: I want to integrate geo data into our product, what libraries can I use?**
|
|
61
|
+
See [geomelon.dev/libraries](https://geomelon.dev/libraries/) for the full list. Official clients: [TypeScript](https://github.com/930m310n/typescript) (`geomelon` on npm), [Python](https://github.com/930m310n/python) (`geomelon` on PyPI), [React](https://github.com/930m310n/geomelon-react) (`geomelon-react` on npm).
|
|
62
|
+
|
|
63
|
+
**Q: I want this data outside npm, e.g. for ML/NLP work?**
|
|
64
|
+
The same per-country data is also published as a [Hugging Face dataset](https://huggingface.co/datasets/geomelon/cities) — one config per country, loaded with `datasets.load_dataset("geomelon/cities", "cameroon")`.
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
The data (`data.json`) is dedicated to the public domain under [CC0 1.0](./LICENSE) — free to use, no attribution required. The loader code (`index.js`/`index.d.ts`) is MIT-licensed. See [ATTRIBUTION.md](./ATTRIBUTION.md) for the data's (optional) credit line.
|
|
69
|
+
|
|
70
|
+
## Source
|
|
71
|
+
|
|
72
|
+
Generated from [geomelon.dev](https://geomelon.dev) — an API and dataset built on [Wikidata](https://www.wikidata.org). See the full live API on [RapidAPI](https://rapidapi.com/hom3chuk/api/geomelon).
|