plotly-kz-map


Nameplotly-kz-map JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
SummaryA Python package that provides a simple interface to create Kazakhstan maps using Plotly
upload_time2024-08-17 21:01:06
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Plotly Kazakhstan Map

[![PyPI version](https://badge.fury.io/py/plotly-kz-map.svg)](https://badge.fury.io/py/plotly-kz-map)

`plotly_kz_map` — is a Python package that provides a simple interface to create
Kazakhstan maps using [Plotly](https://github.com/plotly/plotly.py).

## Installation

```bash
pip install plotly-kz-map
```

## Features

- Drop in replacement for Plotly `choropleth` function, but with Kazakhstan
  regions support.

## Example

Here is an example using `plotly_kz_map` to visualize the population
of Kazakhstan by regions.

```python
import plotly_kz_map as px

# load a sample dataset as a pandas DataFrame
df = px.data.kazakhstan_population()

fig = px.choropleth(
    locations=df.region,
    locationmode="KZ-regions",
    color=df.population,
)

fig.show()
```

![Plotly Kazakhstan Map continuous](https://github.com/aidoskanapyanov/plotly-kz-map/blob/main/images/plotly-kz-map-continuous.png?raw=true)

Or you can use a discrete color scale:

```python
import plotly_kz_map as px

# load a sample dataset as a pandas DataFrame
df = px.data.kazakhstan_population()

fig = px.choropleth(
    locations=df.region,
    locationmode="KZ-regions",
    color=df.region,
)

fig.show()
```

![Plotly Kazakhstan Map discrete](https://github.com/aidoskanapyanov/plotly-kz-map/blob/main/images/plotly-kz-map-discrete.png?raw=true)

## Notes

`locations` keyword argument should be a list of region names abbreviated as
following (check `px.data.kazakhstan_population().region` to see the full list):

```python
{
    "ABY": "Abay Region",
    "AKM": "Akmola Region",
    "AKT": "Aktobe Region",
    "ALR": "Almaty Region",
    "ATY": "Atyrau Region",
    "EKR": "East Kazakhstan Region",
    "JMB": "Jambyl Region",
    "JTS": "Jetisu Region",
    "KGD": "Karaganda Region",
    "KST": "Kostanay Region",
    "KZY": "Kyzylorda Region",
    "MNG": "Mangystau Region",
    "NKR": "North Kazakhstan Region",
    "PVD": "Pavlodar Region",
    "TRK": "Turkistan Region",
    "ULY": "Ulytau Region",
    "WKR": "West Kazakhstan Region",
    "ALA": "Almaty",
    "AST": "Astana",
    "SHY": "Shymkent",
}
```

## License

[MIT](LICENSE)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "plotly-kz-map",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Aidos Kanapyanov <aidos.kanapyanov2@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/26/58/9c8af6f3279f6bcf077138894b3af0164d71f0831dfb3b88146393a23cdb/plotly_kz_map-0.0.3.tar.gz",
    "platform": null,
    "description": "# Plotly Kazakhstan Map\n\n[![PyPI version](https://badge.fury.io/py/plotly-kz-map.svg)](https://badge.fury.io/py/plotly-kz-map)\n\n`plotly_kz_map` \u2014 is a Python package that provides a simple interface to create\nKazakhstan maps using [Plotly](https://github.com/plotly/plotly.py).\n\n## Installation\n\n```bash\npip install plotly-kz-map\n```\n\n## Features\n\n- Drop in replacement for Plotly `choropleth` function, but with Kazakhstan\n  regions support.\n\n## Example\n\nHere is an example using `plotly_kz_map` to visualize the population\nof Kazakhstan by regions.\n\n```python\nimport plotly_kz_map as px\n\n# load a sample dataset as a pandas DataFrame\ndf = px.data.kazakhstan_population()\n\nfig = px.choropleth(\n    locations=df.region,\n    locationmode=\"KZ-regions\",\n    color=df.population,\n)\n\nfig.show()\n```\n\n![Plotly Kazakhstan Map continuous](https://github.com/aidoskanapyanov/plotly-kz-map/blob/main/images/plotly-kz-map-continuous.png?raw=true)\n\nOr you can use a discrete color scale:\n\n```python\nimport plotly_kz_map as px\n\n# load a sample dataset as a pandas DataFrame\ndf = px.data.kazakhstan_population()\n\nfig = px.choropleth(\n    locations=df.region,\n    locationmode=\"KZ-regions\",\n    color=df.region,\n)\n\nfig.show()\n```\n\n![Plotly Kazakhstan Map discrete](https://github.com/aidoskanapyanov/plotly-kz-map/blob/main/images/plotly-kz-map-discrete.png?raw=true)\n\n## Notes\n\n`locations` keyword argument should be a list of region names abbreviated as\nfollowing (check `px.data.kazakhstan_population().region` to see the full list):\n\n```python\n{\n    \"ABY\": \"Abay Region\",\n    \"AKM\": \"Akmola Region\",\n    \"AKT\": \"Aktobe Region\",\n    \"ALR\": \"Almaty Region\",\n    \"ATY\": \"Atyrau Region\",\n    \"EKR\": \"East Kazakhstan Region\",\n    \"JMB\": \"Jambyl Region\",\n    \"JTS\": \"Jetisu Region\",\n    \"KGD\": \"Karaganda Region\",\n    \"KST\": \"Kostanay Region\",\n    \"KZY\": \"Kyzylorda Region\",\n    \"MNG\": \"Mangystau Region\",\n    \"NKR\": \"North Kazakhstan Region\",\n    \"PVD\": \"Pavlodar Region\",\n    \"TRK\": \"Turkistan Region\",\n    \"ULY\": \"Ulytau Region\",\n    \"WKR\": \"West Kazakhstan Region\",\n    \"ALA\": \"Almaty\",\n    \"AST\": \"Astana\",\n    \"SHY\": \"Shymkent\",\n}\n```\n\n## License\n\n[MIT](LICENSE)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package that provides a simple interface to create Kazakhstan maps using Plotly",
    "version": "0.0.3",
    "project_urls": {
        "Homepage": "https://github.com/aidoskanapyanov/plotly-kz-map",
        "Issues": "https://github.com/aidoskanapyanov/plotly-kz-map/issues",
        "Source": "https://github.com/aidoskanapyanov/plotly-kz-map"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f06900fe84d79336bb679d30ef549935a64fcf224c892cbbe9780489bd89e7d6",
                "md5": "8206abf0390e285aa745ff442445e923",
                "sha256": "c68cda49a4d218c2d7c43a253df324706288019a6eb6b7f9abc5096e9175c452"
            },
            "downloads": -1,
            "filename": "plotly_kz_map-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8206abf0390e285aa745ff442445e923",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1226529,
            "upload_time": "2024-08-17T21:01:03",
            "upload_time_iso_8601": "2024-08-17T21:01:03.951054Z",
            "url": "https://files.pythonhosted.org/packages/f0/69/00fe84d79336bb679d30ef549935a64fcf224c892cbbe9780489bd89e7d6/plotly_kz_map-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "26589c8af6f3279f6bcf077138894b3af0164d71f0831dfb3b88146393a23cdb",
                "md5": "553c5f1176a57fc7947ba071af83ddc3",
                "sha256": "d76229884c8d305518a5e73a030f588a4fbdba7e3a326060fa906e40e645dfff"
            },
            "downloads": -1,
            "filename": "plotly_kz_map-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "553c5f1176a57fc7947ba071af83ddc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1293526,
            "upload_time": "2024-08-17T21:01:06",
            "upload_time_iso_8601": "2024-08-17T21:01:06.636952Z",
            "url": "https://files.pythonhosted.org/packages/26/58/9c8af6f3279f6bcf077138894b3af0164d71f0831dfb3b88146393a23cdb/plotly_kz_map-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-17 21:01:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aidoskanapyanov",
    "github_project": "plotly-kz-map",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "plotly-kz-map"
}
        
Elapsed time: 0.49089s