Metadata-Version: 2.1
Name: cpr-generator
Version: 0.2.2
Summary: An unofficial tool for generating and verifying Danish CPR-numbers.
Author-email: HackTheOxidation <tomas.hagenau@protonmail.ch>
License: Copyright (c) 2023 HackTheOxidation
        
        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.
Project-URL: Homepage, https://codeberg.org/HackTheOxidation/cpr-generator
Project-URL: Bug Tracker, https://codeberg.org/HackTheOxidation/cpr-generator/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# `cpr-generator` - An Unofficial library and tool for generating and verifying Danish CPR-numbers.

This project contains a library and some CLI-tools for generating, manipulating and verifying Danish CPR-numbers,
called "personnummer" or "CPR-nummer" in Danish, as defined by the Danish authority ["Det
Centrale Personregister"](https://cpr.dk/cpr-systemet/opbygning-af-cpr-nummeret).

## Disclaimer

This is a community project that is NOT indorsed by the Danish authorities and should
not be used as a reference.

## Getting Started

This is available on PyPI via. `pip` which includes both the library and the CLI-tools.
Simply install with the command:

```sh
pip install -U cpr-generator
```

### Using the Library

The library contains a few different modules. Most important are the `cpr_verifier` and the
`generator` modules.

The `cpr_verifier` contains three functions:

- `is_leap_year`: takes a year (`int`) checks whether the year is a leap year.
- `is_cpr_number`: takes a potential CPR-number (`str`) and checks that it fulfills
the format: `DDMMYY(-)NNNN`.
- `satisfies_mod11` takes a potential CPR-number (`str`), checks that it fulfills both
the format: `DDMMYY(-)NNNN` and the Modulus-11 control condition.

### Using the CLI-tools

#### `cpr-gen`

This is a simple CLI tool that can generate random CPR-numbers, with or without hyphens.

Example usage:

```sh
cpr-gen -n 1000 -m False --hyphen True
```

The above generates a thousand CPR-numbers with hyphens, not satisfying the Modulus-11
control condition.

#### `cpr-server`

This CLI-tools starts a HTTP server (using `flask`) on port 5000 that can generate random
CPR-numbers on demand.

Simply run:

```sh
cpr-server
```

And the server should be available at `localhost:5000`.

The server has the following available URL endpoints:

- `/`: Returns a random CPR-number (no hyphen)
- `/no-mod11/`: Returns a random CPR-number (no hyphen), not satisfying Modulus-11.
- `/hyphen/`: Returns a random CPR-number (with hyphen)
- `/no-mod11/hyphen/`: Returns a random CPR-number (with hyphen), not satisfying Modulus-11.
- `/<int:number>/`: Returns `number` random CPR-numbers (no hyphen)
- `/no-mod11/<int:number>/`: Returns `number` random CPR-numbers (no hyphens), not satisfying Modulus-11.
- `/hyphen/<int:number>/`: Returns `number` random CPR-numbers (with hyphens)
- `/no-mod11/hyphen/<int:number>/`: Returns `number` random CPR-numbers (with hyphens), not satisfying Modulus-11.

#### `cpr-verify`

This CLI-tool can be used to check the input fulfills the format of a CPR-number, with or
without hyphen, and whether or not the input satisfies the Modulus-11 control condition.

Example usage:

```sh
cpr-verify 111111-1118  # --> True
```

The above verifies that the input `111111-1118` fulfills the CPR-number format.
