release on pypi

animesh-chouhan · Jun 29, 2021 · d1877a2 · d1877a2
1 parent 2ce6926
commit d1877a2
Show file tree

Hide file tree

Showing 20 changed files with 96 additions and 56 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-vcf_creator/__pycache__/*
+*/__pycache__/*
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ python3 -m vcf_creator sample.csv
 
 To install it right away, type:
 ```sh
-pip install vcf_creator
+pip3 install vcf_creator
 ```
 
 ### Help:
@@ -33,7 +33,7 @@ python3 -m vcf_creator --help
 ### Running the script:
 
 ```sh
-python -m vcf_creator <csv-file-name>
+python3 -m vcf_creator <csv-file-name>
 ```
 ## CSV File Instructions
 

diff --git a/dist/vcf-creator-0.0.4.tar.gz b/dist/vcf-creator-0.0.4.tar.gz
diff --git a/dist/vcf-creator-1.0.2.tar.gz b/dist/vcf-creator-1.0.2.tar.gz
diff --git a/dist/vcf_creator-0.0.4-py3-none-any.whl b/dist/vcf_creator-0.0.4-py3-none-any.whl
diff --git a/dist/vcf_creator-1.0.2-py3-none-any.whl b/dist/vcf_creator-1.0.2-py3-none-any.whl
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="vcf-creator",
-    version="0.0.4",
+    version="1.0.2",
     author="Animesh Singh Chouhan",
     author_email="animeshsingh.iitkgp@gmail.com",
     description="Generate vCard file from CSV",

diff --git a/test_vcf.py b/test_vcf.py
diff --git a/vcf_creator.egg-info/PKG-INFO b/vcf_creator.egg-info/PKG-INFO
@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: vcf-creator
-Version: 0.0.4
-Summary: Generate VCard file from CSV
+Version: 1.0.2
+Summary: Generate vCard file from CSV
 Home-page: https://github.com/animesh-chouhan/vcf-creator
 Author: Animesh Singh Chouhan
 Author-email: animeshsingh.iitkgp@gmail.com
@@ -17,3 +17,73 @@ License-File: LICENSE
 
 # vcf-creator
 
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vcf_creator)
+![PyPI](https://img.shields.io/pypi/v/vcf_creator)
+![license](https://img.shields.io/github/license/animesh-chouhan/vcf-creator)
+
+>Generate vCard file from CSV
+
+## Setup
+
+### Cloning the repository:
+```sh
+# Clone the repo
+git clone https://github.com/animesh-chouhan/vcf-creator.git
+cd vcf-creator
+
+# Run the sample csv file
+python3 -m vcf_creator sample.csv
+```
+
+### Installation:
+
+To install it right away, type:
+```sh
+pip3 install vcf_creator
+```
+
+### Help:
+```sh
+python3 -m vcf_creator --help
+```
+
+### Running the script:
+
+```sh
+python3 -m vcf_creator <csv-file-name>
+```
+## CSV File Instructions
+
+1. The contact CSV file can have the following headers all in smallcase:
+    - name
+    - phone
+    - organisation
+    - email
+    - address
+    - birthday
+2. The headers can be in any order
+3. Make sure that no fields are empty
+
+## Usage example
+Click on the play button to see an example download.
+[![asciicast](https://asciinema.org/a/422828.svg)](https://asciinema.org/a/422828)
+
+_For more examples and usage, please refer to the [Wiki][wiki]._
+
+## Contributing
+
+1. Fork the repo (<https://github.com/animesh-chouhan/vcf-creator/>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+<!-- Markdown link & img dfn's -->
+[license]: https://img.shields.io/github/license/animesh-chouhan/vcf-creator
+[wiki]: https://github.com/animesh-chouhan/vcf-creator/wiki
+
+## License
+MIT License
+copyright (c) 2021 [Animesh Singh Chouhan](https://github.com/animesh-chouhan). Please have a look at the [license](LICENSE) for more details.
+
+
diff --git a/vcf_creator.egg-info/SOURCES.txt b/vcf_creator.egg-info/SOURCES.txt
@@ -8,4 +8,6 @@ vcf_creator/vcf.py
 vcf_creator.egg-info/PKG-INFO
 vcf_creator.egg-info/SOURCES.txt
 vcf_creator.egg-info/dependency_links.txt
-vcf_creator.egg-info/top_level.txt
+vcf_creator.egg-info/top_level.txt
+vcf_creator/tests/__init__.py
+vcf_creator/tests/test_vcf.py
diff --git a/vcf_creator/tests/__init__.py b/vcf_creator/tests/__init__.py
diff --git a/vcf_creator/tests/__pycache__/__init__.cpython-38.pyc b/vcf_creator/tests/__pycache__/__init__.cpython-38.pyc
diff --git a/vcf_creator/tests/__pycache__/test_vcf.cpython-38.pyc b/vcf_creator/tests/__pycache__/test_vcf.cpython-38.pyc
diff --git a/test.csv → vcf_creator/tests/test.csv b/test.csv → vcf_creator/tests/test.csv
diff --git a/test.vcf → vcf_creator/tests/test.vcf b/test.vcf → vcf_creator/tests/test.vcf
diff --git a/vcf_creator/tests/test_vcf.py b/vcf_creator/tests/test_vcf.py
@@ -0,0 +1,17 @@
+import os 
+import unittest
+from vcf_creator.vcf import *
+
+csv = os.path.join(os.path.dirname(__file__), 'test.csv')
+vcf = os.path.join(os.path.dirname(__file__), 'test.vcf')
+
+class TestVcf(unittest.TestCase):
+
+    def test_vcf_generator(self):
+        result = vcard_generator(csv)
+        with open(vcf, "r") as file:
+            text = file.read()
+        self.assertEqual(result, text)       
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/vcf_creator/vcf_creator.egg-info/PKG-INFO b/vcf_creator/vcf_creator.egg-info/PKG-INFO
diff --git a/vcf_creator/vcf_creator.egg-info/SOURCES.txt b/vcf_creator/vcf_creator.egg-info/SOURCES.txt
diff --git a/vcf_creator/vcf_creator.egg-info/dependency_links.txt b/vcf_creator/vcf_creator.egg-info/dependency_links.txt
diff --git a/vcf_creator/vcf_creator.egg-info/top_level.txt b/vcf_creator/vcf_creator.egg-info/top_level.txt