nomiden


Namenomiden JSON
Version 0.0.7 PyPI version JSON
download
home_pagehttps://github.com/divakartika/nomiden
SummaryA Python package to extract information from Indonesian ID Number (NIK, KK)
upload_time2023-11-14 07:11:07
maintainer
docs_urlNone
authorDiva K
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements asttokens backcall beautifulsoup4 bleach brotlipy bs4 certifi cffi charset-normalizer colorama commonmark cryptography debugpy decorator docutils entrypoints executing idna importlib-metadata ipykernel ipython jaraco.classes jedi jupyter_client jupyter_core keyring matplotlib-inline more-itertools nest-asyncio numpy packaging pandas parso pickleshare pip pkginfo prompt-toolkit psutil pure-eval pycparser Pygments pyOpenSSL pyparsing PySocks python-dateutil pytz pyzmq readme-renderer requests requests-toolbelt rfc3986 rich setuptools six soupsieve stack-data tornado traitlets twine urllib3 wcwidth webencodings wheel win-inet-pton wincertstore zipp
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # nomiden

![nomiden code example](https://raw.githubusercontent.com/divakartika/nomiden/main/images/nomiden2.png)

## What is it?

**nomiden** is a Python package that provides information extraction from Indonesian ID Numbers, i.e. personal ID number NIK (Nomor Induk Kependudukan) and family ID number KK (Kartu Keluarga). This package is intended to help users dealing with population and client data to auto-complete missing data or add valuable information, given the ID numbers. Information regarding identity numbers refers to Article 33 of Government Regulation Number 37 of 2007 (Pasal 37 PP Nomor 37 Tahun 2007).

## Main Features
Here are the things that **nomiden** can do for you:

  - Retreive regional information 
    - Province
    - City
    - District
  - Retreive gender information (NIK only)
  - Retreive birth information (NIK only)
    - Age
    - Birthday (e.g. 15 June 2000)
    - Birth date
    - Birth month
    - Birth year
    - Birth in datetime
  - Retreive registration information (KK only)
    - Registration day (e.g. 15 June 2000)
    - Registration date
    - Registration month
    - Registration year
    - Registration in datetime
  - Registration order
  - Complete information in a dictionary

## Where to get it
The source code is currently hosted on GitHub at: [https://github.com/divakartika/nomiden](https://github.com/divakartika/nomiden)

**nomiden** is available at the [Python Package Index (PyPI)](https://pypi.org/project/nomiden/).

```sh
pip install nomiden
```

## Requirements & Dependencies
- Python 3.7 and above
- [Pandas - Supports data-related operations](https://pandas.pydata.org)

## License
[MIT](LICENSE)

## Documentation
[https://nomiden.readthedocs.io](https://nomiden.readthedocs.io)

## Development
This package was built under Python 3.10.8 for Windows 10 and passed the Github Actions: Python package tests under Python 3.8, 3.9, and 3.10 for Ubuntu-latest, MacOS-latest, Windows-latest. To contribute for development, please use [requirements.txt](https://github.com/divakartika/nomiden/blob/main/requirements.txt).

## Data Source
Region code data used in this package is retrieved from [kodewilayah](https://github.com/kodewilayah/permendagri-72-2019) based on the Regulation of the Minister of Home Affairs number 72 of 2019 (Permendagri No. 72 tahun 2019).

## Release Notes

### v0.0.7
Bug fixes and performance improvement.

### v0.0.6
Return `NaN` if birth date (NIK) or registration date (KK) is invalid.

### v0.0.5
Return `NaN` if region code is invalid.

## Getting Help & Discussion

For usage questions and development discussions, feel free to contact diva@algorit.ma.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/divakartika/nomiden",
    "name": "nomiden",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Diva K",
    "author_email": "diva@algorit.ma",
    "download_url": "https://files.pythonhosted.org/packages/e4/ce/348624ee8210e289e24eb52233a1d575cab24157d9ec13f317cfe0f94e0c/nomiden-0.0.7.tar.gz",
    "platform": null,
    "description": "# nomiden\r\n\r\n![nomiden code example](https://raw.githubusercontent.com/divakartika/nomiden/main/images/nomiden2.png)\r\n\r\n## What is it?\r\n\r\n**nomiden** is a Python package that provides information extraction from Indonesian ID Numbers, i.e. personal ID number NIK (Nomor Induk Kependudukan) and family ID number KK (Kartu Keluarga). This package is intended to help users dealing with population and client data to auto-complete missing data or add valuable information, given the ID numbers. Information regarding identity numbers refers to Article 33 of Government Regulation Number 37 of 2007 (Pasal 37 PP Nomor 37 Tahun 2007).\r\n\r\n## Main Features\r\nHere are the things that **nomiden** can do for you:\r\n\r\n  - Retreive regional information \r\n    - Province\r\n    - City\r\n    - District\r\n  - Retreive gender information (NIK only)\r\n  - Retreive birth information (NIK only)\r\n    - Age\r\n    - Birthday (e.g. 15 June 2000)\r\n    - Birth date\r\n    - Birth month\r\n    - Birth year\r\n    - Birth in datetime\r\n  - Retreive registration information (KK only)\r\n    - Registration day (e.g. 15 June 2000)\r\n    - Registration date\r\n    - Registration month\r\n    - Registration year\r\n    - Registration in datetime\r\n  - Registration order\r\n  - Complete information in a dictionary\r\n\r\n## Where to get it\r\nThe source code is currently hosted on GitHub at: [https://github.com/divakartika/nomiden](https://github.com/divakartika/nomiden)\r\n\r\n**nomiden** is available at the [Python Package Index (PyPI)](https://pypi.org/project/nomiden/).\r\n\r\n```sh\r\npip install nomiden\r\n```\r\n\r\n## Requirements & Dependencies\r\n- Python 3.7 and above\r\n- [Pandas - Supports data-related operations](https://pandas.pydata.org)\r\n\r\n## License\r\n[MIT](LICENSE)\r\n\r\n## Documentation\r\n[https://nomiden.readthedocs.io](https://nomiden.readthedocs.io)\r\n\r\n## Development\r\nThis package was built under Python 3.10.8 for Windows 10 and passed the Github Actions: Python package tests under Python 3.8, 3.9, and 3.10 for Ubuntu-latest, MacOS-latest, Windows-latest. To contribute for development, please use [requirements.txt](https://github.com/divakartika/nomiden/blob/main/requirements.txt).\r\n\r\n## Data Source\r\nRegion code data used in this package is retrieved from [kodewilayah](https://github.com/kodewilayah/permendagri-72-2019) based on the Regulation of the Minister of Home Affairs number 72 of 2019 (Permendagri No. 72 tahun 2019).\r\n\r\n## Release Notes\r\n\r\n### v0.0.7\r\nBug fixes and performance improvement.\r\n\r\n### v0.0.6\r\nReturn `NaN` if birth date (NIK) or registration date (KK) is invalid.\r\n\r\n### v0.0.5\r\nReturn `NaN` if region code is invalid.\r\n\r\n## Getting Help & Discussion\r\n\r\nFor usage questions and development discussions, feel free to contact diva@algorit.ma.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python package to extract information from Indonesian ID Number (NIK, KK)",
    "version": "0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/divakartika/nomiden"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4981e094501ffa9842a150cc269cc0944a76a9eaa38be9860cf494846ef3bb7b",
                "md5": "8a96588d2588860203d7e901c2f3d8f0",
                "sha256": "e1532cc151ef5f9b5a9ece0d8894177eb650f391ba68fe2051d0269c62717939"
            },
            "downloads": -1,
            "filename": "nomiden-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8a96588d2588860203d7e901c2f3d8f0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 1506257,
            "upload_time": "2023-11-14T07:11:03",
            "upload_time_iso_8601": "2023-11-14T07:11:03.551612Z",
            "url": "https://files.pythonhosted.org/packages/49/81/e094501ffa9842a150cc269cc0944a76a9eaa38be9860cf494846ef3bb7b/nomiden-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4ce348624ee8210e289e24eb52233a1d575cab24157d9ec13f317cfe0f94e0c",
                "md5": "9086064c893b35d9f87cae3dd29bead8",
                "sha256": "28949917b6a769a09b61697c8af00a05d59473d4a27bb8b8972e50a340b0f65e"
            },
            "downloads": -1,
            "filename": "nomiden-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "9086064c893b35d9f87cae3dd29bead8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 1503995,
            "upload_time": "2023-11-14T07:11:07",
            "upload_time_iso_8601": "2023-11-14T07:11:07.429368Z",
            "url": "https://files.pythonhosted.org/packages/e4/ce/348624ee8210e289e24eb52233a1d575cab24157d9ec13f317cfe0f94e0c/nomiden-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-14 07:11:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "divakartika",
    "github_project": "nomiden",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "asttokens",
            "specs": [
                [
                    "==",
                    "2.0.5"
                ]
            ]
        },
        {
            "name": "backcall",
            "specs": [
                [
                    "==",
                    "0.2.0"
                ]
            ]
        },
        {
            "name": "beautifulsoup4",
            "specs": [
                [
                    "==",
                    "4.11.1"
                ]
            ]
        },
        {
            "name": "bleach",
            "specs": [
                [
                    "==",
                    "5.0.1"
                ]
            ]
        },
        {
            "name": "brotlipy",
            "specs": [
                [
                    "==",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "bs4",
            "specs": [
                [
                    "==",
                    "0.0.1"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    "==",
                    "2023.7.22"
                ]
            ]
        },
        {
            "name": "cffi",
            "specs": [
                [
                    "==",
                    "1.15.1"
                ]
            ]
        },
        {
            "name": "charset-normalizer",
            "specs": [
                [
                    "==",
                    "2.0.4"
                ]
            ]
        },
        {
            "name": "colorama",
            "specs": [
                [
                    "==",
                    "0.4.5"
                ]
            ]
        },
        {
            "name": "commonmark",
            "specs": [
                [
                    "==",
                    "0.9.1"
                ]
            ]
        },
        {
            "name": "cryptography",
            "specs": [
                [
                    "==",
                    "41.0.4"
                ]
            ]
        },
        {
            "name": "debugpy",
            "specs": [
                [
                    "==",
                    "1.5.1"
                ]
            ]
        },
        {
            "name": "decorator",
            "specs": [
                [
                    "==",
                    "5.1.1"
                ]
            ]
        },
        {
            "name": "docutils",
            "specs": [
                [
                    "==",
                    "0.19"
                ]
            ]
        },
        {
            "name": "entrypoints",
            "specs": [
                [
                    "==",
                    "0.4"
                ]
            ]
        },
        {
            "name": "executing",
            "specs": [
                [
                    "==",
                    "0.8.3"
                ]
            ]
        },
        {
            "name": "idna",
            "specs": [
                [
                    "==",
                    "3.4"
                ]
            ]
        },
        {
            "name": "importlib-metadata",
            "specs": [
                [
                    "==",
                    "6.0.0"
                ]
            ]
        },
        {
            "name": "ipykernel",
            "specs": [
                [
                    "==",
                    "6.15.2"
                ]
            ]
        },
        {
            "name": "ipython",
            "specs": [
                [
                    "==",
                    "8.6.0"
                ]
            ]
        },
        {
            "name": "jaraco.classes",
            "specs": [
                [
                    "==",
                    "3.2.3"
                ]
            ]
        },
        {
            "name": "jedi",
            "specs": [
                [
                    "==",
                    "0.18.1"
                ]
            ]
        },
        {
            "name": "jupyter_client",
            "specs": [
                [
                    "==",
                    "7.3.5"
                ]
            ]
        },
        {
            "name": "jupyter_core",
            "specs": [
                [
                    "==",
                    "4.11.2"
                ]
            ]
        },
        {
            "name": "keyring",
            "specs": [
                [
                    "==",
                    "23.13.1"
                ]
            ]
        },
        {
            "name": "matplotlib-inline",
            "specs": [
                [
                    "==",
                    "0.1.6"
                ]
            ]
        },
        {
            "name": "more-itertools",
            "specs": [
                [
                    "==",
                    "9.0.0"
                ]
            ]
        },
        {
            "name": "nest-asyncio",
            "specs": [
                [
                    "==",
                    "1.5.5"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "1.23.4"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": [
                [
                    "==",
                    "21.3"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "==",
                    "1.5.1"
                ]
            ]
        },
        {
            "name": "parso",
            "specs": [
                [
                    "==",
                    "0.8.3"
                ]
            ]
        },
        {
            "name": "pickleshare",
            "specs": [
                [
                    "==",
                    "0.7.5"
                ]
            ]
        },
        {
            "name": "pip",
            "specs": [
                [
                    "==",
                    "22.2.2"
                ]
            ]
        },
        {
            "name": "pkginfo",
            "specs": [
                [
                    "==",
                    "1.9.6"
                ]
            ]
        },
        {
            "name": "prompt-toolkit",
            "specs": [
                [
                    "==",
                    "3.0.20"
                ]
            ]
        },
        {
            "name": "psutil",
            "specs": [
                [
                    "==",
                    "5.9.0"
                ]
            ]
        },
        {
            "name": "pure-eval",
            "specs": [
                [
                    "==",
                    "0.2.2"
                ]
            ]
        },
        {
            "name": "pycparser",
            "specs": [
                [
                    "==",
                    "2.21"
                ]
            ]
        },
        {
            "name": "Pygments",
            "specs": [
                [
                    "==",
                    "2.11.2"
                ]
            ]
        },
        {
            "name": "pyOpenSSL",
            "specs": [
                [
                    "==",
                    "22.0.0"
                ]
            ]
        },
        {
            "name": "pyparsing",
            "specs": [
                [
                    "==",
                    "3.0.9"
                ]
            ]
        },
        {
            "name": "PySocks",
            "specs": [
                [
                    "==",
                    "1.7.1"
                ]
            ]
        },
        {
            "name": "python-dateutil",
            "specs": [
                [
                    "==",
                    "2.8.2"
                ]
            ]
        },
        {
            "name": "pytz",
            "specs": [
                [
                    "==",
                    "2022.6"
                ]
            ]
        },
        {
            "name": "pyzmq",
            "specs": [
                [
                    "==",
                    "23.2.0"
                ]
            ]
        },
        {
            "name": "readme-renderer",
            "specs": [
                [
                    "==",
                    "37.3"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.28.1"
                ]
            ]
        },
        {
            "name": "requests-toolbelt",
            "specs": [
                [
                    "==",
                    "0.10.1"
                ]
            ]
        },
        {
            "name": "rfc3986",
            "specs": [
                [
                    "==",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.1.0"
                ]
            ]
        },
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "67.0.0"
                ]
            ]
        },
        {
            "name": "six",
            "specs": [
                [
                    "==",
                    "1.16.0"
                ]
            ]
        },
        {
            "name": "soupsieve",
            "specs": [
                [
                    "==",
                    "2.3.2.post1"
                ]
            ]
        },
        {
            "name": "stack-data",
            "specs": [
                [
                    "==",
                    "0.2.0"
                ]
            ]
        },
        {
            "name": "tornado",
            "specs": [
                [
                    "==",
                    "6.2"
                ]
            ]
        },
        {
            "name": "traitlets",
            "specs": [
                [
                    "==",
                    "5.1.1"
                ]
            ]
        },
        {
            "name": "twine",
            "specs": [
                [
                    "==",
                    "4.0.2"
                ]
            ]
        },
        {
            "name": "urllib3",
            "specs": [
                [
                    "==",
                    "1.26.12"
                ]
            ]
        },
        {
            "name": "wcwidth",
            "specs": [
                [
                    "==",
                    "0.2.5"
                ]
            ]
        },
        {
            "name": "webencodings",
            "specs": [
                [
                    "==",
                    "0.5.1"
                ]
            ]
        },
        {
            "name": "wheel",
            "specs": [
                [
                    "==",
                    "0.38.4"
                ]
            ]
        },
        {
            "name": "win-inet-pton",
            "specs": [
                [
                    "==",
                    "1.1.0"
                ]
            ]
        },
        {
            "name": "wincertstore",
            "specs": [
                [
                    "==",
                    "0.2"
                ]
            ]
        },
        {
            "name": "zipp",
            "specs": [
                [
                    "==",
                    "3.11.0"
                ]
            ]
        }
    ],
    "lcname": "nomiden"
}
        
Elapsed time: 0.14987s