Add generation method and update version to 0.1.4

This commit adds a generation function and random function with date ranges.

Author: miglen

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
+max-line-length = 120
+max-complexity = 20

.travis.yml

@@ -1,7 +1,6 @@
 language: python
 python:
-- "2.7"
-- "3.6"
+- "3.8"
 deploy:
   provider: pypi
   user: miglen
@@ -15,7 +14,7 @@ notifications:
 install:
   - pip install -r test/requirements.txt
   - pip install .
-script: 
+script:
   - pep8
   - pytest --cov=./egn/
 after_success:

README.rst

@@ -49,7 +49,7 @@ Python package
   >>> ....
 
   # Generating with options
-  egn_options = {'year': 1999, 'month': 3, 'day': 3, 'region': 'Sofia', 'sex': 'm'}
+  egn_options = {'year': 1999, 'month': 3, 'day': 3, 'region': 'Sofia', 'gender': 'm'}
   egn.generate(egn_options)
   >>> ....
 
@@ -70,7 +70,7 @@ Here are the most common commands:
 
   # Parse
   $ egn -p 1234567890
-  
+
   # Generate
   $ egn -g # random without options
   $ egn -g -y 1999 -m 3 -d 3 -r Sofia -s male # with options

egn/__init__.py

@@ -2,45 +2,150 @@
 import argparse
 import sys
 import random
+from datetime import timedelta, datetime
+import json
 
 egn_regions = {
-    43: {'bg': 'Благоевград', 'en': 'Blagoevgrad'},  # 000 - 043
-    93: {'bg': 'Бургас', 'en': 'Burgas'},  # 044 - 093
-    139: {'bg': 'Варна', 'en': 'Varna'},  # 094 - 139
-    169: {'bg': 'Велико Търново', 'en': 'Veliko Turnovo'},  # 140 - 169
-    183: {'bg': 'Видин', 'en': 'Vidin'},  # 170 - 183
-    217: {'bg': 'Враца', 'en': 'Vratza'},  # 184 - 217
-    233: {'bg': 'Габрово', 'en': 'Gabrovo'},  # 218 - 233
-    281: {'bg': 'Кърджали', 'en': 'Kurdzhali'},  # 234 - 281
-    301: {'bg': 'Кюстендил', 'en': 'Kyustendil'},  # 282 - 301
-    319: {'bg': 'Ловеч', 'en': 'Lovech'},  # 302 - 319
-    341: {'bg': 'Монтана', 'en': 'Montana'},  # 320 - 341
-    377: {'bg': 'Пазарджик', 'en': 'Pazardzhik'},  # 342 - 377
-    395: {'bg': 'Перник', 'en': 'Pernik'},  # 378 - 395
-    435: {'bg': 'Плевен', 'en': 'Pleven'},  # 396 - 435
-    501: {'bg': 'Пловдив', 'en': 'Plovdiv'},  # 436 - 501
-    527: {'bg': 'Разград', 'en': 'Razgrad'},  # 502 - 527
-    555: {'bg': 'Русе', 'en': 'Ruse'},  # 528 - 555
-    575: {'bg': 'Силистра', 'en': 'Silistra'},  # 556 - 575
-    601: {'bg': 'Сливен', 'en': 'Sliven'},  # 576 - 601
-    623: {'bg': 'Смолян', 'en': 'Smolyan'},  # 602 - 623
-    721: {'bg': 'София', 'en': 'Sofia'},  # 624 - 721
-    751: {'bg': 'София (окръг)', 'en': 'Sofia (county)'},  # 722 - 751
-    789: {'bg': 'Стара Загора', 'en': 'Stara Zagora'},  # 752 - 789
-    821: {'bg': 'Добрич', 'en': 'Dobrich'},  # 790 - 821
-    843: {'bg': 'Търговище', 'en': 'Targovishte'},  # 822 - 843
-    871: {'bg': 'Хасково', 'en': 'Haskovo'},  # 844 - 871
-    903: {'bg': 'Шумен', 'en': 'Shumen'},  # 872 - 903
-    925: {'bg': 'Ямбол', 'en': 'Yambol'},  # 904 - 925
-    999: {'bg': 'Друг', 'en': 'Other'}}  # 926 - 999
-
-
-def generate(**kwargs):
-    '''
-    Method to generate numbers.
-    '''
+    # https://www.iso.org/obp/ui/#iso:code:3166:BG
+    43: {'bg': 'Благоевград', 'en': 'Blagoevgrad', 'start': 0, 'iso': 'BG-01'},  # 000 - 043
+    93: {'bg': 'Бургас', 'en': 'Burgas', 'start': 44, 'iso': 'BG-02'},  # 044 - 093
+    139: {'bg': 'Варна', 'en': 'Varna', 'start': 94, 'iso': 'BG-03'},  # 094 - 139
+    169: {'bg': 'Велико Търново', 'en': 'Veliko Turnovo', 'start': 140, 'iso': 'BG-04'},  # 140 - 169
+    183: {'bg': 'Видин', 'en': 'Vidin', 'start': 170, 'iso': 'BG-05'},  # 170 - 183
+    217: {'bg': 'Враца', 'en': 'Vratza', 'start': 184, 'iso': 'BG-06'},  # 184 - 217
+    233: {'bg': 'Габрово', 'en': 'Gabrovo', 'start': 218, 'iso': 'BG-07'},  # 218 - 233
+    281: {'bg': 'Кърджали', 'en': 'Kurdzhali', 'start': 234, 'iso': 'BG-09'},  # 234 - 281
+    301: {'bg': 'Кюстендил', 'en': 'Kyustendil', 'start': 282, 'iso': 'BG-10'},  # 282 - 301
+    319: {'bg': 'Ловеч', 'en': 'Lovech', 'start': 302, 'iso': 'BG-11'},  # 302 - 319
+    341: {'bg': 'Монтана', 'en': 'Montana', 'start': 320, 'iso': 'BG-12'},  # 320 - 341
+    377: {'bg': 'Пазарджик', 'en': 'Pazardzhik', 'start': 342, 'iso': 'BG-13'},  # 342 - 377
+    395: {'bg': 'Перник', 'en': 'Pernik', 'start': 378, 'iso': 'BG-14'},  # 378 - 395
+    435: {'bg': 'Плевен', 'en': 'Pleven', 'start': 396, 'iso': 'BG-15'},  # 396 - 435
+    501: {'bg': 'Пловдив', 'en': 'Plovdiv', 'start': 436, 'iso': 'BG-16'},  # 436 - 501
+    527: {'bg': 'Разград', 'en': 'Razgrad', 'start': 502, 'iso': 'BG-17'},  # 502 - 527
+    555: {'bg': 'Русе', 'en': 'Ruse', 'start': 528, 'iso': 'BG-18'},  # 528 - 555
+    575: {'bg': 'Силистра', 'en': 'Silistra', 'start': 556, 'iso': 'BG-19'},  # 556 - 575
+    601: {'bg': 'Сливен', 'en': 'Sliven', 'start': 576, 'iso': 'BG-20'},  # 576 - 601
+    623: {'bg': 'Смолян', 'en': 'Smolyan', 'start': 602, 'iso': 'BG-21'},  # 602 - 623
+    721: {'bg': 'София', 'en': 'Sofia', 'start': 624, 'iso': 'BG-22'},  # 624 - 721
+    751: {'bg': 'София (окръг)', 'en': 'Sofia (county)', 'start': 722, 'iso': 'BG-23'},  # 722 - 751
+    789: {'bg': 'Стара Загора', 'en': 'Stara Zagora', 'start': 752, 'iso': 'BG-24'},  # 752 - 789
+    821: {'bg': 'Добрич', 'en': 'Dobrich', 'start': 790, 'iso': 'BG-08'},  # 790 - 821
+    843: {'bg': 'Търговище', 'en': 'Targovishte', 'start': 822, 'iso': 'BG-25'},  # 822 - 843
+    871: {'bg': 'Хасково', 'en': 'Haskovo', 'start': 844, 'iso': 'BG-26'},  # 844 - 871
+    903: {'bg': 'Шумен', 'en': 'Shumen', 'start': 872, 'iso': 'BG-27'},  # 872 - 903
+    925: {'bg': 'Ямбол', 'en': 'Yambol', 'start': 904, 'iso': 'BG-28'},  # 904 - 925
+    999: {'bg': 'Друг', 'en': 'Other', 'start': 926, 'iso': 'BG-XX'}}  # 926 - 999
+
+
+def generate_random(gender=None,
+                    region=None,
+                    limit=10):
+    """
+    Generate a random EGN.
+    """
+    egns = []
+    while len(egns) < limit:
+        if region is None:
+            rr = random.randint(1, 28)
+            rand_region = f"BG-{rr:02d}"
+        else:
+            rand_region = region
+        year = random.randint(1800, datetime.today().year - 1)
+        month = random.randint(1, 12)
+        day = random.randint(1, 28)
+        date_from = f"{year}-{month}-{day}"
+        date_to = datetime.today().strftime('%Y-%m-%d')
+        rand_egn = generate(date_from=date_from, date_to=date_to, region=rand_region, gender=gender, limit=1)
+        if len(rand_egn) == 1:
+            egns.append(rand_egn[0])
+    return egns
+
+
+def generate(date_from="1800-01-01",
+             date_to=datetime.today().strftime('%Y-%m-%d'),
+             gender=None,
+             region=None,
+             limit=10):
+    """
+    Generate egn within boundaries.
+    """
+    def get_region_range(region="Other"):
+        """
+        Get region code.
+        Region could be the latin, cyrrilic or ISO 3166 anotation of the region.
+        """
+        start = 0
+        end = 0
+        for i in egn_regions:
+            if region.lower() in [egn_regions[i]['en'].lower(),
+                                  egn_regions[i]['bg'].lower(),
+                                  egn_regions[i]['iso'].lower()]:
+                start = egn_regions[i]['start']
+                end = i
+        return start, end
+
+    def get_dates_range(date_from, date_to, limit=None):
+        """
+            Generate all dates between date range in ENG suitable format.
+            Params in ISO 8601 format.
+        """
+        dates = []
+        try:
+            sdate = datetime.strptime(date_from, '%Y-%m-%d')
+            edate = datetime.strptime(date_to, '%Y-%m-%d')
+            delta = edate - sdate
+
+            for i in range(delta.days + 1):
+                if limit is not None and i > limit:
+                    return dates
+                dday = str(sdate + timedelta(days=i))
+                year, month, day = int(dday[0:4]), int(dday[6:7]), int(dday[8:10])
+                if year >= 2000:
+                    month += 40
+                    year -= 2000
+                elif year < 1900:
+                    month += 20
+                    year -= 1800
+                else:
+                    # Gregorian calendar adoption: 31/03/1916 > +13 days > 14/04/1916
+                    if year == 1916 and month == 4 and day <= 13:
+                        continue
+                    year -= 1900
+                dates.append(f"{year:02d}{month:02d}{day:02d}")
+            return dates
+        except Exception as e:
+            print(e)
+            return None
+
+    egns = []
+    if not region:
+        regions = range(0, 999, 1)
+    else:
+        region_start, region_end = get_region_range(region)
+        regions = range(region_start, region_end, 1)
 
-    return '9941011142'
+    if gender is not None:
+        if gender[0].lower() == 'm':  # Male
+            regions = [x for x in regions if x % 2 == 0]
+        else:  # Female
+            regions = [x for x in regions if x % 2]
+
+    regions = [f"{x:02d}" for x in regions]
+    dates = get_dates_range(date_from, date_to, limit=limit)
+    counter = 1
+
+    # Generate the list of egns
+    for dt in dates:
+        for region in regions:
+            for check_num in range(0, 9, 1):
+                egene = f"{dt}{region}{check_num}"
+                if validate(egene):
+                    counter += 1
+                    egns.append(egene)
+                    if counter > limit:
+                        return egns
+    return egns
 
 
 def get_date(egn):
@@ -51,7 +156,7 @@ def get_date(egn):
     from datetime import datetime
     try:
         year, month, day = int(egn[0:2]), int(egn[2:4]), int(egn[4:6])
-    except:
+    except Exception:
         return False
     if month >= 40:
         month -= 40
@@ -111,6 +216,7 @@ def parse(egn):
     '''
         Parse the EGN information and return hash with the values
     '''
+    egn = str(egn)
     if not validate(egn):
         raise Exception('Invalid EGN')
     egn_hash = {}
@@ -125,12 +231,15 @@ def parse(egn):
         if key > region_num:
             egn_hash['region_bg'] = value['bg']
             egn_hash['region_en'] = value['en']
+            egn_hash['region_iso'] = value['iso']
             break
 
     # Parse the gender
-    egn_hash['gender'] = 'male'
+    egn_hash['gender'] = 'Male'
     if int(egn[8:9]) % 2:
-        egn_hash['gender'] = 'female'
+        egn_hash['gender'] = 'Female'
+
+    egn_hash['egn'] = egn
 
     return egn_hash
 
@@ -140,41 +249,39 @@ def parse_args(args):
         Method to parse the arguments to the program.
     '''
     parser = argparse.ArgumentParser()
-
-    parser.add_argument("-v", "--validate", help="Validate EGN",
-                        type=int)
-    parser.add_argument("-p", "--parse", help="Parse EGN",
-                        type=int)
-    # Generate
-    parser.add_argument("-g", "--generate", help="Generate EGN",
-                        action="store_true")
-    parser.add_argument("-s", "--sex", help="Sex/gender",
-                        type=str, choices=['male', 'female', 'm', 'f'],
-                        default=random.choice(['m', 'f']))
-    parser.add_argument("-y", "--year", help="Year (between 1800-2099)",
-                        type=int, default=random.randint(1800, 2099))
-    parser.add_argument("-m", "--month", help="Month (between 1-12)",
-                        type=int, default=random.randint(1, 12))
-    parser.add_argument("-d", "--day", help="Day (between 1-31)",
-                        type=int, default=random.randint(1, 31))
-    parser.add_argument("-r", "--region", help="Region (pernik/sofia etc.)",
-                        type=str, default=random.choice(['Pernik', 'Sofia']))
+    today = format(datetime.today().strftime('%Y-%m-%d'))
+    parser.add_argument("-v", "--validate", help="Validate EGN", type=str)
+    parser.add_argument("-p", "--parse", help="Parse EGN", type=str)
+    # Generation
+    parser.add_argument("-l", "--limit", help="Limit of generated results (default: 1)", type=int, default=1)
+    parser.add_argument("-r", "--random", help="Generate random EGN (default limit: 1)", action="store_true")
+    parser.add_argument("-g", "--generate", help="Generate EGN", action="store_true")
+    parser.add_argument("--gender", help="Gender - Male or Female", type=str, choices=['m', 'f'])
+    parser.add_argument("--region", help="Region (Latin/Cyrrilic region name or ISO 3166 format)", type=str)
+    parser.add_argument("--from", help="Date from generate (Y-m-d) (default: 1800-01-01)",
+                        type=str, default='1800-01-01')
+    parser.add_argument("--to", type=str, help=f"Date to generate (Y-m-d) (default: {today})", default=today)
     return vars(parser.parse_args(args))
 
 
 def calc_args(parser):
     '''
-        Method to parse the argparse values and return output
+        Method to parse the argparse values and return an output.
     '''
 
     if 'parse' in parser and parser['parse']:
         validate_egn = str(parser['parse'])
         if not validate(validate_egn):
             print("{} is invalid!".format(validate_egn))
             exit(1)
-        print(parse(validate_egn))
+        validate_egn = parse(validate_egn)
+        validate_egn.pop('datetime')
+        print(json.dumps(validate_egn))
+    elif 'random' in parser and parser['random']:
+        print("\n".join(generate_random(limit=parser['limit'], region=parser['region'], gender=parser['gender'])))
     elif 'generate' in parser and parser['generate']:
-        print(generate())
+        print("\n".join(generate(limit=parser['limit'], region=parser['region'], gender=parser['gender'],
+                                 date_from=parser['from'],  date_to=parser['to'])))
     elif 'validate' in parser and parser['validate']:
         validate_egn = str(parser['validate'])
         if validate(validate_egn):

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='egn',
-    version='0.1.3',
+    version='0.1.4',
     packages=find_packages(exclude=['tests']),
     include_package_data=True,
     license='GPL-3.0',  # example license

test/test_cli.py

@@ -17,15 +17,16 @@ def test_cli_parse(capsys):
     egn_options = {'parse': 9941011142}
     egn.calc_args(egn_options)
     out, err = capsys.readouterr()
-    assert ('Varna' in out and '2099' in out and 'male' in out)
+    assert ('Varna' in out and '2099' in out and 'Male' in out)
 
 
 def test_cli_generate(capsys):
     ''' Test generate via cli '''
-    egn_options = {'generate': True}
+    egn_options = {'generate': True, 'limit': 1, 'region': 'Sofia', 'gender': 'm',
+                   'from': '2020-01-01', 'to': '2020-12-12'}
     egn.calc_args(egn_options)
     out, err = capsys.readouterr()
-    assert out == "9941011142\n"
+    assert egn.validate(out.strip()) is True
 
 
 def test_cli_validation(capsys):

test/test_egn.py

@@ -1,19 +1,19 @@
 # -*- coding: utf-8 -*-
 import egn
-import sys
-import datetime
-import pytest
 
 
-def test_generation():
-    ''' Test generation produces valid egn '''
-    assert egn.validate(egn.generate())
+def test_generation_options():
+    ''' Test generation produce valid egn with options '''
+    for i in egn.generate(region='Pernik', gender='m', limit=100):
+        assert egn.validate(i)
 
 
-def test_generation_options():
+def test_generation_random():
     ''' Test generation produce valid egn with options '''
-    assert egn.validate(egn.generate(region=1, sex=1, day=1, month=1,
-                        year=2000, limit=100))
+    random = egn.generate_random(limit=10)
+    assert len(random) == 10
+    for i in random:
+        assert egn.validate(i)
 
 
 def test_valid():