Some more changes & making a proper Python module

Author: tech4242

.gitignore

@@ -3,108 +3,14 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
-# dotenv
-.env
-
-# virtualenv
-.venv
-venv/
-ENV/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-
 # pycharm
 .idea
 
 # vcards
 *.vcf
 
 # csvs
-*.csv
+*.csv
+
+# Export folder
+export

README.md

@@ -1,5 +1,5 @@
-# python-csv-to-vcard
-A Python script that parses a .csv file of contacts and automatically creates vCards. The vCards are super useful for sending your contact details or those of your team. You can also upload them to e.g. Dropbox and use them with QR codes! You can also use them for transering new contacts to Outlook, a new CRM etc. The specific use case in mind was to programmatically create vCards from a list of contacts in a spreadsheet, to be incorporated into business cards.
+# csv2vcard
+A Python script that parses a .csv file of contacts and automatically creates vCards. The vCards are super useful for sending your contact details or those of your team. You can also upload them to e.g. Dropbox and use them with QR codes! You can also use them for transferring new contacts to Outlook, a new CRM etc. The specific use case in mind was to programmatically create vCards from a list of contacts in a spreadsheet, to be incorporated into business cards.
 
 # Usage
 
@@ -13,10 +13,13 @@ A Python script that parses a .csv file of contacts and automatically creates vC
 
 **Important: you should name the columns exactly the same way because they are used as keys to generate the vCards**
 
-2. Download `csv_to_vcard.py`
+2. `git clone` or download and `cd` to folder
 
 3. Open python `python3` (gotcha: using Python 3.6 features)
 
-4. Import module `import csv_to_vcard`
+4. Import module `from csv2vcard import csv2vcard`
 
-5. Run script `csv_to_vcard.csv_to_vcard(your_file_name)`. This will create an /export/ dir with your vCards!
+5. Now you have 2 options for running. Both will create an /export/ dir with an example vCards.
+
+  * Test the app with `csv2vcard.test_csv2vcard()`. This will create a Forrest Gump test vCard!
+  * Use your real data `csv2vcard.csv2vcard(yourfilename)`. This will create all your vCards!

csv-to-vcard/csv_to_vcard.py

@@ -0,0 +1,25 @@
+def create_vcard(contact: dict):
+    """
+    The mappings used below are from https://www.w3.org/TR/vcard-rdf/#Mapping
+    """
+    vc_begin = "BEGIN:VCARD\n"
+    vc_version = "VERSION:3.0\n"
+    vc_name = f"N;CHARSET=UTF-8:{contact['last_name']};{contact['first_name']};;;\n"
+    vc_title = f"TITLE;CHARSET=UTF-8:{contact['title']}\n"
+    vc_org = f"ORG;CHARSET=UTF-8:{contact['org']}\n"
+    vc_phone = f"TEL;TYPE=WORK,VOICE:{contact['phone']}\n"
+    vc_email = f"EMAIL;TYPE=WORK:{contact['email']}\n"
+    vc_website = f"URL;TYPE=WORK:{contact['website']}\n"
+    vc_address = f"ADR;TYPE=WORK;CHARSET=UTF-8:{contact['street']};{contact['city']};{contact['p_code']};{contact['country']}\n"
+    vc_end = "END:VCARD\n"
+
+    vc_filename = f"{contact['last_name'].lower()}_{contact['first_name'].lower()}.vcf"
+    vc_output = vc_begin + vc_version + vc_name + vc_title + vc_org + vc_phone + vc_email + vc_website + vc_address + vc_end
+
+    vc_final = {
+        "filename" : vc_filename,
+        "output" : vc_output,
+        "name" : contact['first_name'] + contact['last_name'],
+    }
+
+    return vc_final

csv-to-vcard/__init__.py renamed to csv2vcard/__init__.py

@@ -0,0 +1,32 @@
+from csv2vcard.export_vcard import check_export, export_vcard
+from csv2vcard.create_vcard import create_vcard
+from csv2vcard.parse_csv import parse_csv
+
+
+def csv2vcard(csv_filename: str):
+    """
+    Main function
+    """
+    check_export()
+
+    for c in parse_csv(csv_filename):
+        vcard = create_vcard(c)
+        export_vcard(vcard)
+
+
+def test_csv2vcard():
+    """
+    Try it out with this mock Forrest Gump contact
+    """
+    mock_contacts = [{
+        "last_name": "Gump", "first_name": "Forrest", "title": "Shrimp Man",
+        "org": "Bubba Gump Shrimp Co.",
+        "phone": "+49 170 5 25 25 25", "email": "[email protected]",
+        "website": "https://www.linkedin.com/in/forrestgump",
+        "street": "42 Plantation St.", "city": "Baytown", "p_code": "30314",
+        "country": "United States of America"
+    }]
+    check_export()
+    vcard = create_vcard(mock_contacts[0])
+    print(vcard)
+    export_vcard(vcard)

csv2vcard/create_vcard.py

@@ -0,0 +1,22 @@
+import os
+
+def export_vcard(vc_final):
+    """
+    Exporting a vCard to /export/
+    """
+    try:
+        with open(f"export/{vc_final['filename']}", "w") as f:
+            f.write(vc_final['output'])
+            f.close()
+            print(f"Created vCard 3.0 for {vc_final['name']}.")
+    except IOError:
+        print(f"I/O error for {vc_final['filename']}")
+
+
+def check_export():
+    """
+    Checks if export folder exists in directory
+    """
+    if not os.path.exists("export"):
+        print("Creating /export folder...")
+        os.makedirs("export")

csv2vcard/csv2vcard.py

@@ -0,0 +1,17 @@
+import csv
+import codecs
+
+def parse_csv(csv_filename: str):
+    """
+    Simple csv parser with a ; delimiter
+    """
+    print("Parsing csv..")
+    try:
+        with codecs.open(f"{csv_filename}", "r", "utf-8-sig") as f:
+            contacts = csv.reader(f, delimiter=";")
+            header = next(contacts)  # saves header
+            parsed_contacts = [dict(zip(header, row)) for row in contacts]
+            return parsed_contacts
+    except IOError:
+        print(f"I/O error for {csv_filename}")
+        return []

csv2vcard/export_vcard.py

@@ -1,13 +1,13 @@
 from distutils.core import setup
 setup(
-  name = 'csv-to-vcard',
-  packages = ['csv-to-vcard'], # this must be the same as the name above
+  name = 'csv2vcard',
+  packages = ['csv2vcard'], # this must be the same as the name above
   version = '0.1',
   description = 'A library for converting csvs to vCards',
   author = 'Nikolay Dimolarov',
   author_email = '[email protected]',
-  url = 'https://github.com/tech4242/python-csv-to-vcard', # use the URL to the github repo
-  download_url = 'https://github.com/peterldowns/mypackage/archive/0.1.tar.gz', # I'll explain this in a second
+  url = 'https://github.com/tech4242/csv2vcard', # use the URL to the github repo
+  download_url = 'https://github.com/tech4242/csv2vcard/archive/0.1.tar.gz', # I'll explain this in a second
   keywords = ['csv', 'vcard', 'export'],
   classifiers = [],
 )