Merge pull request #111 from gorimaaa/python

Python modifications

Author: ZibanPirate

python/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python/README.md

@@ -1,6 +1,49 @@
-# kuliya for python
-## **How to Use**
-1. **Run the script** with the JSON file path as an argument:
-   ```bash
-   python3 main.py <path-to-json-file>
-   ```
+# kulya_python
+
+`kulya_python` is a Python package designed to facilitate access to structured JSON data as part of the Kulya project. It allows you to retrieve information from a centralized JSON file.
+
+## Installation
+
+To install `kulya_python`, you can use `pip`:
+
+```bash
+pip install kulya_python
+```
+
+## Usage
+
+Here is a simple example of how to use the kulya_python package:
+
+```python
+from kulya_python import getNodeByPath
+
+# Example usage to retrieve a specific node
+node = getNodeByPath('umkb/fst')
+print(node.getNameFr())
+```
+
+## Developers
+
+If you want to reload the data.json (because \_data changed), set `DEVELOPMENT_MODE` to True and call `getNodeByPath(anypath)` below utils.py
+
+## How to publish the package
+
+Get into the root folder where `pyproject.toml` is and do these steps :
+`py -m build`
+`pip install -U packaging` (debug for twine)
+`py -m pip install --upgrade twine`
+`py -m twine upload  dist/*` put your API token when asked
+You can then access to the package with
+`pip install [package-name]`
+
+## Project Structure
+
+    kulya_python/: Main package directory.
+        utils.py: Contains utility functions, including getNodeByPath.
+        node.py: Defines the Node class used to encapsulate JSON data.
+        data.json: Centralized JSON file containing the necessary data.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+Contact

python/dist/kulya_python-1.6-py3-none-any.whl

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "kulya_python"
+version = "1.6"
+authors = [
+  { name="Gorimaaa" },
+]
+description = "A package to make the python part of the kulya project"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/dzcode-io/kuliya"
+Issues = "https://github.com/dzcode-io/kuliya/issues"
+
+[tool.hatch.build.targets.wheel]
+only-include = ["src/kulya_python", "data"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src" = ""
+"data" = "kulya_python/src/kulya_python/data.json"
+

python/dist/kulya_python-1.6.tar.gz

@@ -0,0 +1 @@
+from .utils import getNodeByPath