Skip to content

Commit cb86127

Browse files
committed
updated README file
1 parent afb44a2 commit cb86127

File tree

7 files changed

+89
-5
lines changed

7 files changed

+89
-5
lines changed

Diff for: .gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
__pycache__/
2+
*.pyc
3+
conversion_modules/__pycache__/
4+
conversion_modules/__pycache__/json_to_csv.cpython-37.pyc
5+
conversion_modules/__pycache__/mcsv_to_xlsx.cpython-37.pyc

Diff for: README.md

+82-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,83 @@
1-
# json-excel
2-
a python script to convert JSON files into Excel Files
1+
# :sparkles: json-excel :sparkles:
2+
Simple python scripts to convert :
3+
* JSON to Excel :white_check_mark:
4+
* JSON to CSV :white_check_mark:
5+
* Multiple CSV to single Excel :white_check_mark:
6+
:relieved:
7+
----
38

4-
[ourEx.xlsx](https://github.com/mage1k99/json-excel/blob/master/ourEx.xlsx) is the converted Excel file :/
9+
## How to Use :question: ##
10+
11+
### Convert on the Go ###
12+
13+
1. Clone the modules and navigate
14+
15+
2. Run `python3 main.py `
16+
1. select the requied option
17+
2. enter the **file name as absolute path if it exist on other directories**
18+
(for windows users)
19+
for eg:
20+
if the file is loacated at C:\Documents\collection.json
21+
And You want the generated output file at C:\Documents\exported\output.xlsx
22+
```
23+
C:\Users\Mage1k99\json-excel>python3 main.py
24+
1. JSON to Excel
25+
2. JSON to CSV
26+
3. Multiple CSV files to Excel
27+
your option (from 1 to 3) : 1
28+
Path of JSON file : C:\Users\Documents\collection.json
29+
Sheetname (optional) : mysheet
30+
Path of Output Excel :C:\Users\Documents\output.xlsx
31+
```
32+
(for linux and mac users)
33+
eg:
34+
if the input file is located at ~/json/inputcollection.json
35+
And the output file (xlsx) to be generated at ~/excel/outputexcel.xlsx
36+
```
37+
mage:~/json-excel$ python3 main.py
38+
1. JSON to Excel
39+
2. JSON to CSV
40+
3. Multiple CSV files to Excel
41+
your option (from 1 to 3) : 1
42+
Path of JSON file : ~/json/outputexcel.xlsx
43+
Sheetname (optional) : mysheet
44+
Path of Output Excel : ~/excel/outputexcel.xlsx
45+
```
46+
> :exclamation: check to be done before conversion :exclamation:
47+
> * use python3, (as python2.7 will reach its [end of life](https://pythonclock.org)
48+
> * Always add ___extension to the filepaths while using___
49+
> * before entering output path make sure that the directory exist!
50+
> * Give the correct file and path name
51+
52+
### using as seprate modules ###
53+
54+
Just use the conversion module in your own projects by importing
55+
56+
----
57+
58+
### screenshots ###
59+
screenshot of running main.py with files in absolute path
60+
61+
![screenshot of running main.py](https://github.com/mage1k99/image_hostingRepo/blob/master/json-excel_asserts/Screenshot.png "Screenshot of running main.py")
62+
63+
![screenshot of genrated output from main.py](https://github.com/mage1k99/image_hostingRepo/blob/master/json-excel_asserts/generated_output.png "screenshot of output")
64+
65+
----
66+
### Requirements ###
67+
68+
* pandas
69+
* openpyxl
70+
* setuptools
71+
72+
`pip3 install -r requirements.txt`
73+
74+
Based on python library pandas
75+
76+
----
77+
##### Contributions are welcomed :smile: ####
78+
79+
Feel free to
80+
* Fork, modify to add feature and make pull request :clap:
81+
* report bugs, request feature through issues :clap:
82+
83+
##### Thank you for using and spending your time with this project :sparkling_heart: #####

Diff for: __pycache__/get_json.cpython-37.pyc

-799 Bytes
Binary file not shown.
-23 Bytes
Binary file not shown.
104 Bytes
Binary file not shown.

Diff for: exported_sample/generated_excel.json.xlsx

4.71 KB
Binary file not shown.

Diff for: requirements.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
pandas
1+
openpyxl==3.0.2
2+
pandas==0.25.3
23
setuptools
3-
openpyxl

0 commit comments

Comments
 (0)