ckanapi-harvesters 0.0.0__py3-none-any.whl

ckanapi_harvesters/__init__.py

@@ -0,0 +1,15 @@
+"""
+Module for demonstrating a simple 'Hello World' function.
+
+This module imports the hello_world function from the main module
+and makes it available for public use.
+
+Functions
+---------
+hello_world()
+    Print 'Hello World!' to the console.
+"""
+
+from .main import hello_world
+
+__all__ = ['hello_world']

ckanapi_harvesters/divider/__init__.py

@@ -0,0 +1,27 @@
+"""
+Module for division operations and custom exceptions.
+
+This module provides functions and exceptions related to division operations.
+It imports the `divide` function and the `CantDivideByZeroError` exception from
+other modules and makes them available for use in this module.
+
+Functions
+---------
+divide(a, b)
+    Divide two numbers, raising a custom exception if the divisor is zero.
+
+Exceptions
+----------
+CantDivideByZeroError
+    Raised when an attempt is made to divide by zero.
+
+Imports
+--------
+- divide: Function for performing division operations.
+- CantDivideByZeroError: Exception raised for division by zero errors.
+"""
+
+from .divider import divide
+from .divider_error import CantDivideByZeroError
+
+__all__ = ['divide', 'CantDivideByZeroError']

ckanapi_harvesters/divider/divider.py

@@ -0,0 +1,53 @@
+"""
+Module for division operations with custom exceptions.
+
+This module provides a function for performing division
+and raises a custom exception when attempting to divide by zero.
+
+Functions
+---------
+divide(a, b)
+    Divide two numbers, raising a custom exception if the divisor is zero.
+
+Exceptions
+----------
+CantDivideByZeroError
+    Raised when an attempt is made to divide by zero.
+"""
+
+from .divider_error import CantDivideByZeroError
+
+
+def divide(a, b):
+    """
+    Divide two numbers, raising a custom exception if the divisor is zero.
+
+    Parameters
+    ----------
+    a : float
+        The dividend.
+    b : float
+        The divisor.
+
+    Returns
+    -------
+    float
+        The result of the division.
+
+    Raises
+    ------
+    CantDivideByZeroError
+        If the divisor (b) is zero.
+
+    Examples
+    --------
+    >>> divide(10, 2)
+    5.0
+    >>> divide(10, 0)
+    Traceback (most recent call last):
+        ...
+    CantDivideByZeroError
+    """
+    if b == 0:
+        raise CantDivideByZeroError()
+    return a / b

ckanapi_harvesters/divider/divider_error.py

@@ -0,0 +1,59 @@
+"""
+Module for custom exceptions related to calculator operations.
+
+This module defines custom exceptions used in calculator operations,
+including a base exception class and a specific exception for division by zero errors.
+
+Classes
+-------
+CalculatorError
+    Base class for exceptions in calculator operations.
+CantDivideByZeroError
+    Exception raised when an attempt is made to divide by zero.
+
+Exceptions
+----------
+CalculatorError
+    Base class for exceptions in the calculator domain.
+CantDivideByZeroError
+    Raised specifically for division by zero errors.
+"""
+
+
+class CalculatorError(Exception):
+    """
+    Base class for exceptions in calculator operations.
+
+    This class is intended to be used as a base class for other calculator-related
+    exceptions. It inherits from the built-in Exception class and allows for custom
+    exception handling in the calculator domain.
+
+    Parameters
+    ----------
+    args : tuple
+        Variable length argument list passed to the base Exception class.
+    """
+
+    def __init__(self, *args):
+        super().__init__(args)
+
+
+class CantDivideByZeroError(CalculatorError):
+    """
+    Exception raised when an attempt is made to divide by zero.
+
+    This exception is a specific subclass of CalculatorError and is intended to be
+    used when a division by zero error occurs. It provides a custom error message
+    indicating that division by zero is not allowed.
+
+    Parameters
+    ----------
+    None
+
+    Notes
+    -----
+    The default message for this exception is "tu ne peux pas diviser par zéro".
+    """
+
+    def __init__(self):
+        super().__init__('tu ne peux pas diviser par zéro')

ckanapi_harvesters/main.py

@@ -0,0 +1,30 @@
+"""
+Module containing simple demonstration functions.
+
+This module provides basic example functions to demonstrate
+simple Python functionality.
+
+Functions
+---------
+hello_world()
+    Print 'Hello World!' to the console.
+"""
+
+
+def hello_world():
+    """
+    Print 'Hello World!' to the console.
+
+    Parameters
+    ----------
+    None
+
+    Returns
+    -------
+    None
+
+    Notes
+    -----
+    - This function simply prints the message 'Hello World!' to the standard output.
+    """
+    print('Hello World!')

ckanapi_harvesters-0.0.0.dist-info/METADATA

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: ckanapi_harvesters
+Version: 0.0.0
+Summary: Adaptation of the template for github.
+License: MIT License
+        
+        Copyright (c) 2024 ifpen
+        
+        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.
+        
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pytest==8.0.1
+
+# ckanapi_harvesters
+
+---
+
+## Description
+
+This "Python Package" template is a complete template designed to create a Python package according to IFPEN's development standards, deployable internally within IFPEN or on the Cloud. This template provides developers with a Python project architecture in which they can contribute, document, and make it available to all IFPEN developers.
+
+This package includes:
+- A unit test structure based on the [Pytest](https://docs.pytest.org/en/stable/) library
+- Automatic documentation generation based on the [Sphinx](https://www.sphinx-doc.org/en/master/) library
+- A CI/CD pipeline for deploying the Python package to a Python server
+
+## Github Pages
+
+Your automaticly generated documentation (with Sphinx) is [Here](https://mobidec.github.io/ckanapi_harvesters/)
+
+## Python Package Template Architecture
+
+
+```
+.
+├── sphinx
+│   ├── conf.py
+│   │    └── Sphinx documentation configuration file
+│   └── index.rst
+│        └── Root file for Sphinx documentation, structuring and linking source documents into complete documentation.
+├── src
+│   └── ckanapi_harvesters
+│        ├── __init__.py
+│        ├── main.py
+│        │    └── Main file of your package, it references what is usable in your package
+│        └── module_name
+│             ├── __init__.py
+│             └── module.py
+│                  └── Module file, each module holds a logic of the package
+├── tests
+│    └── Directory for testing the package and verifying that everything works
+├── .gitattributes
+│    └── Ensures that all text files use LF as the line ending, improving consistency across different development environments.
+├── .bumpversion.toml
+│    └── Configuration file for bumping the package version
+├── .gitignore
+│    └── File explicitly instructed for Git to ignore
+├── .github
+│    └── workflows
+│         └── Github Ci/CD files
+├── .pre-commit-config.yaml
+│    └── Pre-commit configuration file
+├── CONTRIBUTING.md
+│    └── Contribution guidelines file
+├── LICENSE
+├── README.md
+│    └── File with general information about the project
+├── pyproject.toml
+│    └── Package configuration file
+└── tox.ini
+     └── Configuration file for `tox`, used to automate testing and linting tasks across multiple Python environments. This file is configured to use Python 3.12 and runs commands for the linter `ruff` as well as for tests with `pytest`. The specified commands check code style, format files according to defined standards, and run unit tests to ensure the code works as expected. This file is also used to facilitate version management tasks with `bump-my-version`.
+```
+
+## Getting Started
+
+### Prerequisites
+
+This project requires **Python 3.12**. Python 3.12 introduces many new features and improvements that are essential for the proper functioning of this project. Ensure that Python is correctly installed on your system by running `python --version`.
+
+### About the `pyproject.toml` File
+
+The `pyproject.toml` file is a central configuration file for the Python project. It contains TOML tables specifying the basic metadata of the project, the dependencies needed to build your project, and specific configurations for the tools used.
+The `[project]` table is used to specify the basic metadata of your project, such as dependencies, your name, etc. The `[tool]` table contains sub-tables specific to each tool, such as `[tool.setuptools]` or `[tool.ruff]`. For more information on configuring your `pyproject.toml`, refer to the [Python documentation](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/).
+
+### Installing Dependencies
+
+The `pyproject.toml` file is used to manage the dependencies of this project. To install these dependencies, follow these steps:
+
+1. Open a terminal and navigate to the project directory.
+2. Run the command `pip install .` to install the necessary dependencies for the project.
+
+This process ensures that all required dependencies are correctly installed in your environment, allowing you to work on the project with all necessary resources.
+
+To add or modify project dependencies, you must list them in your `pyproject.toml` file under the `dependencies` section.
+
+```bash
+dependencies = [
+    "pytest == 8.0.1",
+    # add necessary dependencies
+]
+```
+
+### Developing the Package
+
+The `CONTRIBUTING.md` file is an essential guide for developing this Python package. It describes the steps to set up the development environment, the coding conventions to follow, and how to submit changes. 
+Once your changes are ready, push your contribution to the desired branch to trigger the integration pipeline, which will create the Python package and deploy it to the Python server.
+For more details on contributing and best practices, please refer to the `CONTRIBUTING.md` file.
+
+## Using the Python Package
+
+### Installation
+
+If you are using the provided `pip.conf`, you can simply run:
+
+```bash
+pip install ckanapi_harvesters
+```
+
+Otherwise, you can specify the package index depending on whether you are in an internal (on-premise) or external (cloud) environment.
+
+```bash
+# On-premise
+pip install ckanapi_harvesters --extra-index-url https://nexus.ifpen.fr/repository/fast-it/simple
+
+# On Cloud
+pip install ckanapi_harvesters --extra-index-url https://nexus.fastit.dev/repository/fast-it/simple
+```
+
+Alternatively, you can set the package index URL as an environment variable:
+
+```bash
+# On-premise
+export PIP_EXTRA_INDEX_URL=https://nexus.fastit.dev/repository/fast-it/simple
+
+# On Cloud
+export PIP_EXTRA_INDEX_URL=https://nexus.ifpen.fr/repository/fast-it/simple
+```
+
+### Example Usage of the Python Package in Your Code
+
+After installation, you can import and use your package and its functions in your Python code:
+
+```python
+from package import hello_world
+
+hello_world()
+```
+
+To use sub-modules defined in the package:
+
+```python
+from package.divider import divide
+
+a = 4.0
+b = 2.0
+
+c = divide(4., 2.)
+```
+
+These instructions will allow you to access the package and utilize its features effectively and in line with your development configuration.
+
+## License
+
+This project is licensed under the MIT License, which means it is freely usable for personal and commercial purposes. The MIT License is one of the most permissive open source licenses. It allows you to do almost anything with the source code, as long as you retain the original license notice and copyright information when redistributing the software or substantial portions of it. This license comes without any warranties, so the software is provided "as is." For more details, please refer to the included LICENSE file.
+
+---

ckanapi_harvesters-0.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+ckanapi_harvesters/__init__.py,sha256=7CSKdr6QTzRii9ZgPOVpInDaT8up2AlLE603waA6rFU,306
+ckanapi_harvesters/main.py,sha256=6BKP4FfCnsPApGT8F8sodpllBde7X55UkifXXMVY1Bw,508
+ckanapi_harvesters/divider/__init__.py,sha256=Q93V1V4x_TVm5uMBkJIeynFYBa_PpRzc8nQ4O4mtHC4,761
+ckanapi_harvesters/divider/divider.py,sha256=6he0tD5NeCbeVL1eWmRhU5R34h-H2fB-JFE-Ztk60-8,1038
+ckanapi_harvesters/divider/divider_error.py,sha256=S0gdUN6RtSthnZ4NB9_UhKmZDQjEnlS3F9IiGfnEFV0,1659
+ckanapi_harvesters-0.0.0.dist-info/METADATA,sha256=qiQRIkfzQhpjhp3sM5Jqjv42HATK4x_z9g1oF4TuK1o,8448
+ckanapi_harvesters-0.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+ckanapi_harvesters-0.0.0.dist-info/top_level.txt,sha256=WvJprCJXBEK-Eew36dTdVdt9I_r4AdgA2Kur3RhLTPg,19
+ckanapi_harvesters-0.0.0.dist-info/RECORD,,

ckanapi_harvesters-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ckanapi_harvesters-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ckanapi_harvesters