Merge pull request #20 from QubiPy-Labs/v0.2.4-dev

V0.2.4 dev

Author: Mazzya

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Change Log
+## v0.2.4-beta - December 21, 2024
+* Enhanced github documention & online documentation
+* Fixed some links in the documentation
+
 ## v0.2.3-beta - December 19, 2024
 * Included dll, dylib and so files in package distribution to avoid bugs
 

README.md

@@ -1,22 +1,32 @@
 # QubiPy, a Python Library for the QUBIC RPC API
 Currently, QubiPy is in a very early development phase, so please take this into consideration before using the library.
 
-Visit [Change log](CHANGELOG.md)
+Please visit the [Change log](https://github.com/QubiPy-Labs/QubiPy/blob/main/docs/changelog.md) to see all changes.
 
-![v0.2.3](https://img.shields.io/badge/beta_version-0.2.3-green)
+![release](https://img.shields.io/badge/release-v0.2.4--beta-blue)
+![python](https://img.shields.io/badge/python-3.10_%7C_3.11_%7C_3.12-blue)
+![Python Package](https://github.com/QubiPy-Labs/QubiPy/actions/workflows/python-package.yml/badge.svg)
+![Code Quality](https://github.com/QubiPy-Labs/QubiPy/actions/workflows/pylint.yml/badge.svg)
+![license](https://img.shields.io/badge/license-AGPL--3.0-orange)
+![dependabot](https://img.shields.io/badge/dependabot-enabled-025e8c)
 
-###  IMPORTANT NOTICE
+
+###  Important notice
 QubiPy is in beta phase and may change considerably until the stable version. Keep this in mind when using the library.
+
+### Documentation
+To learn more about QubiPy and its complete use, please visit our official [documentation](https://qubipy.readthedocs.io/en/latest/).
+
 ### Requirements
 To install the necessary dependencies, run this command in the console :
 ```
 $ pip install -r requirements.txt
 ```
 
 ### How to use
-You have two ways to use QubiPy, one is by PyPi or by cloning the project from the official repository.
+You have two ways to use QubiPy, one is by [PyPi](https://pypi.org/project/QubiPy/) or by cloning the project from the official repository.
 
-To use the module, it is necessary to import some modules before :
+To use the module, it is necessary to import some classes before :
 ```python
 from qubipy.rpc import rpc_client
 from qubipy.core import core_client
@@ -85,9 +95,7 @@ $ {
 }
 
 ```
-## Documentation
-To learn more about the library, please visit our official [documentation](https://qubipy.readthedocs.io/en/latest/).
 
-### Notes
+### Technical notes
 This library is using `crypto.dll` which is a C extension of Qubic key utility functions and bind it to Python. To build this `crypto.dll`, this repository was used: [https://github.com/serendipity-seeker/key-utils-binding](https://github.com/serendipity-seeker/key-utils-binding).
 

docs/about.md

@@ -56,10 +56,13 @@ Check our [Contributing Guidelines](contributing.md) for more details.
    If you find a problem with the module, please [report it](https://github.com/QubiPy-Labs/QubiPy/issues).
 
 !!! question "Need Help?"
-   - Join our community on [Discord]https://discord.gg/EejFQdQkhG)
+   - Join our community on [Discord](https://discord.gg/EejFQdQkhG)
    - Check our [Documentation](https://qubipy.readthedocs.io)
    - Ask questions on [GitHub Issues](https://github.com/QubiPy-Labs/QubiPy/issues)
 
+## Technical notes
+This library uses crypto.dll, which is a C extension of the Qubic key utility functions and binds them to Python. To build this crypto.dll, this [repository](https://github.com/serendipity-seeker/key-utils-binding) was used.
+
 ## License
 
 !!! info "Open Source"

docs/changelog.md

@@ -1,4 +1,8 @@
 # Change Log
+## v0.2.4-beta - December 21, 2024
+* Enhanced github documention & online documentation
+* Fixed some links in the documentation
+
 ## v0.2.3-beta - December 19, 2024
 * Included dll, dylib and so files in package distribution to avoid bugs
 

docs/index.md

@@ -5,6 +5,13 @@
 
 **QubiPy** is a Python library that provides RPC and Core client functionality. You can interact quickly and easily with the Qubic RPC API using the different methods offered by this library.
 
+![release](https://img.shields.io/badge/release-v0.2.3--beta-blue)
+![python](https://img.shields.io/badge/python-3.10_%7C_3.11-blue)
+![Python Package](https://github.com/QubiPy-Labs/QubiPy/actions/workflows/python-package.yml/badge.svg)
+![Code Quality](https://github.com/QubiPy-Labs/QubiPy/actions/workflows/pylint.yml/badge.svg)
+![license](https://img.shields.io/badge/license-AGPL--3.0-orange)
+![dependabot](https://img.shields.io/badge/dependabot-enabled-025e8c)
+
 ## Main Features
 * RPC endpoints
 * CORE endpoints

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-__version__ = '0.2.3'
+__version__ = '0.2.4'
 
 
 with open("README.md", "r", encoding="utf-8") as fh: