fix: cleaner

Author: Its-Just-Nans

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 src/csv_to_custom_json.egg-info/
 dist/
 .coverage
+build/

CHANGELOG.md

@@ -1,9 +1,30 @@
-# Logs
-
-- 2023-10-08 : Better, remove `customSeparator`
-- 2022-02-11 : Add docs
-- 2022-01-20 :
-  - first release : `https://pypi.org/project/csv-to-custom-json`
-  - note : [https://packaging.python.org/en/latest/tutorials/packaging-projects/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
-  - note : `python3 -m twine upload dist/*`
-- 2021-12-08 : Add option to pass a `list` as `schema`
+# CHANGELOG
+
+## Create a new version
+
+```sh
+rm -rf dist/ build/
+python -m pip install --upgrade build twine
+
+python -m build
+
+python -m twine upload dist/* --verbose
+```
+
+## 2023-10-08
+
+Better, remove `customSeparator`
+
+## 2022-02-11
+
+Add docs
+
+## 2022-01-20
+
+- first release : `https://pypi.org/project/csv-to-custom-json`
+- note : [https://packaging.python.org/en/latest/tutorials/packaging-projects/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
+- note : `python3 -m twine upload dist/*`
+
+## 2021-12-08
+
+Add option to pass a `list` as `schema`

README.md

@@ -5,7 +5,7 @@
 
 ## How to install
 
-- [installation docs](./docs/How-to-install.md)
+- [installation docs](https://github.com/Its-Just-Nans/csv-to-custom-json-python/tree/master/docs/How-to-install.md)
 
 ```sh
 python3 -m pip install csv-to-custom-json
@@ -58,9 +58,9 @@ def callback(value):
     return None
 
 schema = {
-    num1: "string",
-    callback,
-    num3: "int"
+    "num1": "string",
+    "num2": callback,
+    "num3": "int"
 }
 
 result = parseFile("myfile.csv", schema)
@@ -80,26 +80,26 @@ It's the same as a simple schema :
 from csv_to_custom_json import parseFile
 
 schema = {
-    obj1: {
-        obj2: {
-            num4: "string"
+    "obj1": {
+        "obj2": {
+            "num4": "string"
         }
     },
-    num2: "",
-    num3: ""
+    "num2": "",
+    "num3": ""
 }
 result = parseFile("myfile.csv", schema)
 ```
 
 If you want to check some real case, check out the folder `test` in the [GitHub repository](https://github.com/Its-Just-Nans/csv-to-custom-json-python)
 
-If you want to see and use options check that documentation: [How-to-options](./docs/How-to-options.md)
+If you want to see and use options check that documentation: [How-to-options](https://github.com/Its-Just-Nans/csv-to-custom-json-python/tree/master/docs/How-to-options.md)
 
 ## See also
 
-- [Tricks](./docs/How-to-know-more.md)
-- [How-to-options](./docs/How-to-options.md)
-- [CHANGELOG.md](./CHANGELOG.md)
+- [Tricks](https://github.com/Its-Just-Nans/csv-to-custom-json-python/tree/master/docs/How-to-know-more.md)
+- [How-to-options](https://github.com/Its-Just-Nans/csv-to-custom-json-python/tree/master/docs/How-to-options.md)
+- [CHANGELOG.md](https://github.com/Its-Just-Nans/csv-to-custom-json-python/tree/master/CHANGELOG.md)
 - [csv-to-custom-json in JavaScript](https://github.com/Its-Just-Nans/csv-to-custom-json)
 
 ## License

docs/How-to-know-more.md

@@ -9,7 +9,7 @@ def my_func(allValues):
     return "hello"
 
 schema = {
-    num1: [
+    "num1": [
         "num4",
         "text",
         my_func,

docs/How-to-use.md

@@ -30,9 +30,9 @@ def callback(value):
     return None
 
 schema = {
-    num1: "string",
-    callback,
-    num3: "int"
+    "num1": "string",
+    "num2": callback,
+    "num3": "int"
 }
 
 result = parseFile("myfile.csv", schema)
@@ -52,13 +52,13 @@ It's the same as a simple schema :
 from csv_to_custom_json import parseFile
 
 schema = {
-    obj1: {
-        obj2: {
-            num4: "string"
+    "obj1": {
+        "obj2": {
+            "num4": "string"
         }
     },
-    num2: "",
-    num3: ""
+    "num2": "",
+    "num3": ""
 }
 result = parseFile("myfile.csv", schema)
 ```

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = csv-to-custom-json
-version = 0.0.2
+version = 0.0.3
 author = n4n5
 author_email = [email protected]
 description = Easily convert your CSV to custom JSON