pyistat 0.1.0__tar.gz

pyistat-0.1.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

pyistat-0.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: pyistat
+Version: 0.1.0
+Summary: Pyistat is a friendly module made to easily allow anyone to use Python to search and get datasets from ISTAT APIs. There are two modules: the "search" module is used to find datasets and gives all the information needed to build a request URL. The "get" module is used to get data after helping you properly setup the dimensions (the keys, as called by ISTAT). This module was created because I found the lack of documentation by ISTAT frustrating.
+License: MPL-2.0
+Author: Cosimo Di Martino
+Author-email: derto.dimartino@gmail.com
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: datetime (>=5.5,<6.0)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Description-Content-Type: text/markdown
+
+# pyistat
+
+# PyIstat: easy ISTAT APIs requests
+
+Documentation for ISTAT APIs is non-existent and this is a shame. After much grief I created a simple module that allows analysts to search and extract data from their APIs without relying on the outdated information that can be found on the Internet.
+
+## How does it work?
+
+PyIstat has two modules: search and get.
+
+### The search module
+
+With the search module, you can easily request all the dataflows together with their structure. If you are looking for all dataflows, simply use get_dataflows().
+
+```from pyistat import search
+import pandas as pd
+
+df = get_dataflows()
+
+```
+With this code, you'll have a DataFrame with every dataflow available on the ISTAT API. However, if you are looking for a specific dataset, you can use the search_dataflows function.
+
+```
+search_term = ["Gross margin", "Energy"]
+df = search_dataflows(search_term, mode="fast", lang="en", returned="dataframe")
+```
+
+The DataFrame returned will be populated with all the datasets found with those terms in their name. If you want to see what dimensions (keys) and dimension values are available, you can set mode="deep". This will return an additional column with a human-readable set of keys and key values. You can also set the language to lang="it", or you can choose to obtain a .csv file.
+
+```
+search_term = ["Gross margin", "Energy"]
+search_dataflows(search_term, mode="deep", lang="it", returned="csv"
+```
+
+### The get module
+
+After finding the datasets you are most interested in, it's time to get that data from ISTAT APIs. First of all, you can check the dimensions and their ordering by using get_dimensions.
+
+```
+dimensions_df = get_dimensions(dataflow_id)
+```
+
+This will return all the dimensions and their meaning in a readable DataFrame (use Spyder or another IDE with a variable explorer to make it even easier to read). The order of the dimensions will also be displayed, in case you want to pass a list with the dimensions. If you do not want to pass a list, you can pass dimensions as arguments of the function.
+
+```
+# Either pass a list with the ordered dimensions...
+dimensions = ["Q", "W", "", "", "", ""] # Make sure to leave the unwanted dimensions with "".
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3", dimensions, start_period=2020)
+
+
+# Or use kwargs...
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3", end_period=2024, updated_after=2023, freq="Q", correz="W", returned="csv")
+
+# Or simply get the full data available.
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3")
+```
+
+There is an additional variable you can pass to the get_data function, which is force_url=True. Normally, the function checks whether the number of dimensions assigned is the same as the dimensions the dataflow requires, and whether the dimension values you provide are consistent with those of the dataflow. However, for unknown reasons, sometimes the number of dimension found in the structure XML is different from what the dataflow actually requires... In this case, if you are confident the URL is correct (maybe try it in the browser first), you can pass force_url=True to skip the controls.
+
+### To do
+
+I made this module as I found the lack of documentation from ISTAT regarding their API access incredibly frustrating. I needed a quick way to get the data from their APIs in order to improve my data pipeline. However, this code needs some refining still; as of now, it works, but it can be more efficient.
+
+If it gains traction I'd be more than happy to fix it wherever there is the need of fixing.
+
+To do: a .exe that is system-and language-agnostic.
+Fix inefficiencies in the code.
+

pyistat-0.1.0/README.md

@@ -0,0 +1,67 @@
+# pyistat
+
+# PyIstat: easy ISTAT APIs requests
+
+Documentation for ISTAT APIs is non-existent and this is a shame. After much grief I created a simple module that allows analysts to search and extract data from their APIs without relying on the outdated information that can be found on the Internet.
+
+## How does it work?
+
+PyIstat has two modules: search and get.
+
+### The search module
+
+With the search module, you can easily request all the dataflows together with their structure. If you are looking for all dataflows, simply use get_dataflows().
+
+```from pyistat import search
+import pandas as pd
+
+df = get_dataflows()
+
+```
+With this code, you'll have a DataFrame with every dataflow available on the ISTAT API. However, if you are looking for a specific dataset, you can use the search_dataflows function.
+
+```
+search_term = ["Gross margin", "Energy"]
+df = search_dataflows(search_term, mode="fast", lang="en", returned="dataframe")
+```
+
+The DataFrame returned will be populated with all the datasets found with those terms in their name. If you want to see what dimensions (keys) and dimension values are available, you can set mode="deep". This will return an additional column with a human-readable set of keys and key values. You can also set the language to lang="it", or you can choose to obtain a .csv file.
+
+```
+search_term = ["Gross margin", "Energy"]
+search_dataflows(search_term, mode="deep", lang="it", returned="csv"
+```
+
+### The get module
+
+After finding the datasets you are most interested in, it's time to get that data from ISTAT APIs. First of all, you can check the dimensions and their ordering by using get_dimensions.
+
+```
+dimensions_df = get_dimensions(dataflow_id)
+```
+
+This will return all the dimensions and their meaning in a readable DataFrame (use Spyder or another IDE with a variable explorer to make it even easier to read). The order of the dimensions will also be displayed, in case you want to pass a list with the dimensions. If you do not want to pass a list, you can pass dimensions as arguments of the function.
+
+```
+# Either pass a list with the ordered dimensions...
+dimensions = ["Q", "W", "", "", "", ""] # Make sure to leave the unwanted dimensions with "".
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3", dimensions, start_period=2020)
+
+
+# Or use kwargs...
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3", end_period=2024, updated_after=2023, freq="Q", correz="W", returned="csv")
+
+# Or simply get the full data available.
+pil_df = get_data("163_156_DF_DCCN_SQCQ_3")
+```
+
+There is an additional variable you can pass to the get_data function, which is force_url=True. Normally, the function checks whether the number of dimensions assigned is the same as the dimensions the dataflow requires, and whether the dimension values you provide are consistent with those of the dataflow. However, for unknown reasons, sometimes the number of dimension found in the structure XML is different from what the dataflow actually requires... In this case, if you are confident the URL is correct (maybe try it in the browser first), you can pass force_url=True to skip the controls.
+
+### To do
+
+I made this module as I found the lack of documentation from ISTAT regarding their API access incredibly frustrating. I needed a quick way to get the data from their APIs in order to improve my data pipeline. However, this code needs some refining still; as of now, it works, but it can be more efficient.
+
+If it gains traction I'd be more than happy to fix it wherever there is the need of fixing.
+
+To do: a .exe that is system-and language-agnostic.
+Fix inefficiencies in the code.

pyistat-0.1.0/pyistat/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Fri May 30 14:39:59 2025
+
+@author: DiMartino
+"""
+
+from .get import get_data, get_dimensions
+from .search import get_all_dataflows, search_dataflows
+
+__all__ = ['get_data', 'search_dataflows', 'get_all_dataflows', 'get_dimensions']

pyistat-0.1.0/pyistat/errors.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Fri May 30 12:37:57 2025
+
+@author: DiMartino
+"""
+
+class DimensionsOrKwargsError(Exception):
+    """
+    Warning: Either use a dimensions list (make sure it is ordered, get the correct
+    order from get_dimensions) or use kwargs, never both.
+    """
+    def __init__(self, message="Warning: either pass the dimensions in the correct order as a list or use kwargs."):
+        self.message = message
+        super().__init__(self.message)
+        
+class NotAListError(Exception):
+    """
+    Warning: the variable Dimensions must be a list or null. Remember that if you provide a list,
+          you must also provide wildcard values with a void string like ''.
+    """
+    def __init__(self, message="""Warning: the variable Dimensions must be a list or null. Remember that if you provide a list,
+          you must also provide wildcard values with a void string like ''."""):
+        self.message = message
+        super().__init__(self.message)
+        
+class TooManyDimensionsError(Exception):
+    """
+    The dimensions you chose are less or more than those required from the dataflow.
+    """
+    def __init__(self, dimensions, dimensions_dict, message=None):
+        if message is None:
+           message = f"""Warning: the dimensions you chose are {len(dimensions)}, while the dimensions
+                 requested by the dataflow are {len(dimensions_dict.keys())}. If you believe
+                 this is a mistake, you can force the url by adding force_url=True to the function call."""
+        self.message = message
+        super().__init__(self.message)
+        
+class DifferentDimensionValueError(Exception):
+    """
+    Different dimensions found.
+    """
+    def __init__(self, user_dim, dataflow_dim, message=None):
+        if message is None:
+            message = f"""Warning: the dimension value {user_dim} cannot be found in the possible values
+                  for the dimension {dataflow_dim}. Check if the order of the dimensions is correct.
+                  If you believe this is an error, you can force the url by adding
+                  force_url=True to the function call."""
+        self.message = message
+        super().__init__(self.message)
+        
+class KwargsError(Exception):
+    """
+    Error while using arguments. Check the name and value of arguments or use a list.
+    """
+    def __init__(self, message="Error while using arguments. Check the name and value of arguments or use a list.."):
+        self.message = message
+        super().__init__(self.message)
+        
+class OtherResponseCodeError(Exception):
+    """
+    Different response code from 200 found.
+    """
+    def __init__(self, response_code, message=None):
+        if message is None:
+            message = f"""Error {response_code}. Check SDMX documentation and double check the dataflow id spelling."""
+        self.message = message
+        super().__init__(self.message)
+        
+        
+class WrongFormatError(Exception):
+    """
+    Error while determining format.
+    """
+    def __init__(self, message="Wrong format requested. Choose either 'csv' or 'dataframe'."):
+        self.message = message
+        super().__init__(self.message)

pyistat-0.1.0/pyistat/get.py

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Tue May 27 17:01:35 2025
+
+@author: DiMartino
+"""
+
+import pandas as pd
+import requests
+import xml.etree.ElementTree as ET
+import search
+import errors
+from datetime import datetime
+
+def get_data(dataflow_id, dimensions=[], force_url=False, start_period="", end_period="", updated_after="", returned="dataframe", **kwargs):
+    """
+    
+
+    Parameters
+    ----------
+    dataflow_id : String, 
+        the dataflow id of the dataset.
+    dimensions : List, 
+        an ordered list of strings of the dimensions. Make sure to leave it null if you use kwargs. The default is [].
+    force_url : Bool, 
+        used to force the URL request even if the they were not checked against the allowed dimensions. The default is False.
+    start_period : Int, 
+        used to filter for start period. The default is "".
+    end_period : Int, 
+        used to filter for end period. The default is "".
+    updated_after : Int, 
+        used to filter for update period. The default is "".
+    returned : String, 
+        "dataframe" or "csv", the format to be returned. The default is "dataframe".
+    **kwargs : Key=value, 
+        each kwarg will be used in place of the keys of the URL. Can't be used together with the dimensions list. Usage: freq="Q", correz="W"...
+
+
+    Returns
+    -------
+    df : Returns a pandas DataFrame with all the dataflows if you choose the dataframe.
+    csv file: Creates a csv file in the path of your code if you choose the csv.
+
+    """
+    if returned != "dataframe" or returned != "csv":
+        raise errors.WrongFormatError()
+    if dimensions and kwargs:
+        print("Warning: either pass a list that is ordered following the order you can find with get_dimensions, or pass args. You cannot pass both.")
+        raise errors.DimensionsOrKwargsError
+    elif not dimensions and not kwargs:
+        dimensions = ["all"]
+    elif not isinstance(dimensions, list):
+        raise errors.NotAListError
+        return None
+    elif not force_url and dimensions:
+        # Sometimes url checker can bug out for undiscovered reasons, in this case you are free to force the program to request data
+        dimensions_dict = search.deep_search(dataflow_id, get=True)
+        if len(dimensions) != len(dimensions_dict.keys()):
+            raise errors.TooManyDimensionsError(dimensions, dimensions_dict)
+        
+        for user_dim, dataflow_dim in zip(dimensions, dimensions_dict.values()):
+            if user_dim not in dataflow_dim and user_dim != "":
+                raise errors.DifferentDimensionValueError(user_dim, dataflow_dim)
+                
+    elif not force_url and kwargs:
+        dimensions_df = get_dimensions(dataflow_id)
+        dimensions_dict = search.deep_search(dataflow_id, get=True)
+        # Check how many dimensions there are
+        for _ in range(len(dimensions_dict.keys())):
+            dimensions.append("")
+        for key, value in kwargs.items():
+            check = False
+            while not check:
+                for index, row in dimensions_df.iterrows():
+                    if key.casefold() == row["dimension_id"].casefold():
+                        if value.casefold() == row["dimension_value"].casefold():
+                            dimensions[row["order"]-1] = value
+                            check = True
+                if check:
+                    break
+                raise errors.KwargsError()
+    # Checking if time periods are formatted right and building the strings
+    dim_string = '.'.join(dimensions)
+    if start_period=="" and end_period=="":
+        period_string = "all?"
+    elif end_period=="" and isinstance(start_period, int):
+        period_string = f"all?startPeriod={start_period}"
+    elif start_period=="" and isinstance(end_period, int):
+        period_string = f"all?endPeriod={end_period}"
+    elif start_period=="" and isinstance(end_period, int) and end_period=="" and isinstance(start_period, int):
+        period_string = f"all?startPeriod={start_period}&endPeriod={end_period}"
+    else:
+        print("Warning: variables start_period and end_period are not an int or ''. Removed the period_string.")
+        period_string=""
+    if updated_after != "" and isinstance(updated_after,int):
+        period_string.append(f"&updatedAfter={updated_after}")
+    else:
+        print("Warning: updated_after is not an int. Skipped.")
+       
+    api_url = rf"https://esploradati.istat.it/SDMXWS/rest/data/{dataflow_id}/{dim_string}/{period_string}"
+    response = requests.get(api_url)
+    response_code = response.status_code
+    if response_code != 200:
+        raise errors.OtherResponseCodeError(response_code)
+    elif response.status_code == 200:
+        response = response.content.decode('utf-8-sig')
+        tree = ET.ElementTree(ET.fromstring(response)) 
+        namespaces = {
+            'message': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message',
+            'generic': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic',
+            'common': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common'
+        }
+        
+        data = []
+        for series in tree.findall('.//generic:Series', namespaces):
+            series_key = {}
+            series_key_element = series.find('generic:SeriesKey', namespaces)
+            if series_key_element is not None:
+                for value in series_key_element.findall('generic:Value', namespaces):
+                    key_id = value.get('id')
+                    value_text = value.get('value')
+                    series_key[key_id] = value_text
+
+
+            for obs in series.findall('generic:Obs', namespaces):
+                obs_data = series_key.copy()
+                obs_dimension = obs.find('generic:ObsDimension', namespaces)
+                if obs_dimension is not None:
+                    obs_data['TIME_PERIOD'] = obs_dimension.get('value')
+
+                obs_value = obs.find('generic:ObsValue', namespaces)
+                if obs_value is not None:
+                    obs_data['OBS_VALUE'] = obs_value.get('value')
+
+                data.append(obs_data)
+
+        df = pd.DataFrame(data)
+
+        if df.empty:
+            print("No data retrieved. Open a request on GitHub, please.")
+            return None
+        else:
+            if returned == "dataframe":
+                return df
+            elif returned == "csv":
+                df.to_csv(f"{dataflow_id}_data_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv", index=False)
+            
+
+def get_dimensions(dataflow_id, lang="en", get=False, returned="dataframe"):
+    """
+    
+
+    Parameters
+    ----------
+    dataflow_id : String, 
+        the dataflow id of the dataset.
+    lang : String, 
+        "en" or "it", the language the search will be performed in. The default is "en".
+    get : Bool, 
+        used only when called by the function get_dataframe() with force_url=False. The default is False.
+    returned : String, 
+        "dataframe" or "csv", the format to be returned. The default is "dataframe".
+
+    Returns
+    -------
+    df : Returns a pandas DataFrame with all the dataflows if you choose the dataframe.
+    csv file: Creates a csv file in the path of your code if you choose the csv.
+
+    """
+    if returned != "dataframe" or returned != "csv":
+        raise errors.WrongFormatError()
+    namespaces = {
+        'message': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message',
+        'structure': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure',
+        'common': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common',
+        'xml': 'http://www.w3.org/XML/1998/namespace'
+    }
+    data_url = f"https://esploradati.istat.it/SDMXWS/rest/availableconstraint/{dataflow_id}/?references=all&detail=full"
+
+    response = requests.get(data_url)
+    codelist_list = []
+    response_code = response.status_code
+    if response_code != 200:
+        raise errors.OtherResponseCodeError(response_code)
+            
+    response = response.content.decode('utf-8-sig')
+    tree = ET.ElementTree(ET.fromstring(response))
+    cube_region = tree.find('.//structure:CubeRegion', namespaces)
+    key_values = cube_region.findall('.//common:KeyValue', namespaces)
+
+    codelist_list = []
+
+    for codelist in tree.findall(".//structure:Codelist", namespaces):
+        codelist_id = codelist.get('id')[3:]  # Rimuovi il prefisso "CL_"
+        codelist_name = codelist.find(f'.//common:Name[@xml:lang="{lang}"]', namespaces).text
+
+        for code in codelist.findall('.//structure:Code', namespaces):
+            code_id = code.get('id')
+            code_name = code.find(f'.//common:Name[@xml:lang="{lang}"]', namespaces).text
+
+            for idx, key_value in enumerate(key_values):
+                for value in key_value.findall('common:Value', namespaces):
+                    if value.text == code_id:
+                        codelist_list.append({
+                            'dimension_id': codelist_id,
+                            'dimension_name': codelist_name,
+                            'dimension_value': code_id,
+                            'value_explanation': code_name,
+                            'order': idx + 1
+                        })
+                        break
+
+    if not get:
+        df = pd.DataFrame(codelist_list)
+        if returned == "dataframe":
+            return df
+        elif returned == "csv":
+            df.to_csv(f"{dataflow_id}_dimensions")
+    else:
+        return codelist_list
+    

pyistat-0.1.0/pyistat/search.py

@@ -0,0 +1,205 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Tue May 27 14:08:35 2025
+
+@author: DiMartino
+"""
+
+import pandas as pd
+import requests
+import xml.etree.ElementTree as ET
+import errors
+
+def get_all_dataflows(returned="dataframe"):
+    """
+    This function is used in the search_dataflows function to search for dataflows,
+    but it can also be used alone to get all the possible dataflows.
+
+    Returns
+    -------
+    df : Returns a pandas DataFrame with all the dataflows if you choose the dataframe.
+    csv file: Creates a csv file in the path of your code if you choose the csv.
+
+    """
+    # This is the ISTAT url for all dataflows
+    dataflow_url = "https://esploradati.istat.it/SDMXWS/rest/dataflow/ALL/ALL/LATEST"   
+    response = requests.get(dataflow_url)
+    response_code = response.status_code
+    if response_code == 200:
+        response = response.content.decode('utf-8-sig')
+        tree = ET.ElementTree(ET.fromstring(response))
+        # Namespaces for ISTAT' SDMX dataflows
+        namespaces = {
+            'message': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message',
+            'structure': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure',
+            'common': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common'
+        }
+        data = []
+        for dataflow in tree.findall('.//structure:Dataflow', namespaces):
+
+            name_it = None
+            name_en = None
+            for name in dataflow.findall('.//common:Name', namespaces):
+                lang = name.get('{http://www.w3.org/XML/1998/namespace}lang')
+                if lang == 'it':
+                    name_it = name.text
+                elif lang == 'en':
+                    name_en = name.text
+            row = {
+                'id': dataflow.get('id'),
+                'agencyID': dataflow.get('agencyID'),
+                'version': dataflow.get('version'),
+                'isFinal': dataflow.get('isFinal'),
+                'name_it': name_it,
+                'name_en': name_en
+            }
+            data.append(row)
+        
+        df = pd.DataFrame(data)
+        
+        if returned.casefold() == "dataframe" :  
+            return df
+        elif returned.casefold() == "csv":
+            df.to_csv("all_dataflows_ISTAT.csv")
+        else:
+            raise errors.WrongFormatError()
+    else:
+        raise errors.OtherResponseCodeError(response_code)
+        
+
+def search_dataflows(search_term, mode="fast", lang="en", returned="dataframe"):
+    """
+    Allows searching for dataflows starting from strings passed. Can also accept a list.
+
+    Parameters
+    ----------
+    search_term : String or list of strings, 
+        is required to perform a search through the datasets.
+    mode : String, 
+        can be deep or fast. Deep search requires more requests but also gets the dimensions for datasets in a readable way. The default is "fast".
+    lang : String, 
+        "en" or "it", the language the search will be performed in. The default is "en".
+    returned : String, 
+        "dataframe" or "csv", the format to be returned. The default is "dataframe".
+ 
+    Raises
+    ------
+    errors
+        OtherResponseCodeError: when the code response from the API URL is not 200.
+
+    Returns
+    -------
+    df : Returns a pandas DataFrame with all the dataflows if you choose the dataframe.
+    csv file: Creates a csv file in the path of your code if you choose the csv.
+
+    """
+    if returned != "dataframe" or returned != "csv":
+        raise errors.WrongFormatError()
+    # The function must accept either single words or lists
+    if isinstance(search_term, str):
+        search_term = [search_term]
+    df = get_all_dataflows()
+    if df.empty:
+        print("Error: cannot retrieve dataflows from the ISTAT API. Open a request on Github.")
+    
+    # Initialize dataframe
+    search_df = df.copy()
+    search_df = search_df.iloc[:0]
+    for term in search_term:
+        if lang == "en":
+            temp_df = df[df["name_en"].str.contains(term, case=False, na=False)]
+            search_df = pd.concat([search_df, temp_df], ignore_index=True)
+        elif lang == "it":
+            temp_df = df[df["name_it"].str.contains(term, case=False, na=False)]
+            search_df = pd.concat([search_df, temp_df], ignore_index=True)
+        elif lang == "id":
+            temp_df = df[df["id"].str.contains(term, case=False, na=False)]
+            search_df = pd.concat([search_df, temp_df], ignore_index=True)
+        else:
+            print("Language not found.")
+    if search_df.empty:
+        print(f"Warning: the dataflow {term} could not be found.")
+        return None
+    if mode == "fast":
+        if returned == "dataframe":
+            return search_df
+        elif returned == "csv":
+            search_df.to_csv("requested_data.csv", index=False)
+    if mode =="deep":
+        deep_search_df = deep_search(search_df)
+        if returned == "dataframe":
+            return deep_search_df
+        elif returned == "csv":
+            deep_search_df.to_csv("requested_data.csv", index=False)
+        
+
+
+def deep_search(obj, lang="en", get=False):  
+    """
+    This function is used by the search_dataflows function if the selected mode is "deep".
+
+    Parameters
+    ----------
+    obj : Can be a string or a DataFrame.
+    lang : String, 
+        used to select the language of the search. The default is "en".
+    get : Bool, 
+        used only when called by the function in get.py. The default is False.
+
+    Raises
+    ------
+    errors
+        OtherResponseCodeError: when the code response from the API URL is not 200.
+
+    Returns
+    -------
+   df : normal return when used by search_dataflows.
+   dict : return when used to count the keys by get.get_data.
+
+    """
+
+      
+    namespaces = {
+        'message': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message',
+        'structure': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure',
+        'common': 'http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common'
+    }
+    df = obj # Terrible, hopefully temporary workaround that must be resolved otherwise it doesn't work with the get functions.
+    if not isinstance(obj, pd.DataFrame):
+        df = pd.DataFrame({"id":[obj]})            
+    codelist_list = []
+    for index, row in df.iterrows():
+        dataflow_id = row["id"]
+        data_url = f"https://esploradati.istat.it/SDMXWS/rest/availableconstraint/{dataflow_id}/?references=all&detail=full"
+    
+        response = requests.get(data_url)
+        response_code = response.status_code
+        if response_code != 200:
+            raise errors.OtherResponseCodeError(response_code)
+        
+        response = response.content.decode('utf-8-sig')
+        tree = ET.ElementTree(ET.fromstring(response))
+        codelist_dict = {}
+        codelist_full_dict = {}
+        for key_value in tree.findall('.//common:KeyValue', namespaces):
+            key_id = key_value.get('id')
+            if not key_id == "TIME_PERIOD":
+                values = [value.text for value in key_value.findall('common:Value', namespaces)]
+                codelist_dict[key_id] = values
+                formatted_dimensions = "; ".join([f"{key}: {', '.join(values)}" for key, values in codelist_dict.items()])
+                codelist_full_dict.update(codelist_dict)
+        codelist_list.append(formatted_dimensions)
+
+    if get == False:
+        df['Dimensions'] = codelist_list
+        return df
+    return codelist_full_dict
+
+
+
+    
+    
+    
+    
+    
+    

pyistat-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "pyistat"
+version = "0.1.0"
+description = "Pyistat is a friendly module made to easily allow anyone to use Python to search and get datasets from ISTAT APIs. There are two modules: the \"search\" module is used to find datasets and gives all the information needed to build a request URL. The \"get\" module is used to get data after helping you properly setup the dimensions (the keys, as called by ISTAT). This module was created because I found the lack of documentation by ISTAT frustrating."
+authors = [
+    {name = "Cosimo Di Martino",email = "derto.dimartino@gmail.com"}
+]
+license = {text = "Mozilla Public License 2.0"}
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "requests (>=2.32.3,<3.0.0)",
+    "pandas (>=2.2.3,<3.0.0)",
+    "datetime (>=5.5,<6.0)"
+]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"