csv-detective 0.8.1.dev1674__py3-none-any.whl → 0.8.1.dev1720__py3-none-any.whl

csv_detective-0.8.1.dev1674.dist-info/METADATA

@@ -1,268 +0,0 @@
-Metadata-Version: 2.4
-Name: csv_detective
-Version: 0.8.1.dev1674
-Summary: Detect tabular files column content
-Home-page: https://github.com/datagouv/csv_detective
-Author: Etalab
-Author-email: opendatateam@data.gouv.fr
-License: https://spdx.org/licenses/MIT.html#licenseText
-Project-URL: Source, https://github.com/datagouv/csv_detective
-Keywords: CSV data processing encoding guess parser tabular
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: boto3<2,>=1.34.0
-Requires-Dist: dateparser<2,>=1.2.0
-Requires-Dist: faust-cchardet==2.1.19
-Requires-Dist: pandas<3,>=2.2.0
-Requires-Dist: python-dateutil<3,>=2.8.2
-Requires-Dist: Unidecode<2,>=1.3.6
-Requires-Dist: openpyxl==3.1.5
-Requires-Dist: xlrd==2.0.1
-Requires-Dist: odfpy==1.4.1
-Requires-Dist: requests<3,>=2.32.3
-Requires-Dist: python-magic==0.4.27
-Requires-Dist: frformat==0.4.0
-Requires-Dist: Faker>=33.0.0
-Requires-Dist: rstr==3.2.2
-Provides-Extra: dev
-Requires-Dist: pytest==8.3.0; extra == "dev"
-Requires-Dist: responses==0.25.0; extra == "dev"
-Requires-Dist: bumpx==0.3.10; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# CSV Detective
-
-This is a package to **automatically detect column content in tabular files**. The script reads either the whole file or the first few rows and performs various checks to see for each column if it matches with various content types. This is currently done through regex and string comparison.
-
-Currently supported file types: csv, xls, xlsx, ods.
-
-You can also directly feed the URL of a remote file (from data.gouv.fr for instance).
-
-## How To ?
-
-### Install the package
-
-You need to have python >= 3.9 installed. We recommend using a virtual environement.
-
-```
-pip install csv-detective
-```
-
-### Detect some columns
-
-Say you have a tabular file located at `file_path`. This is how you could use `csv_detective`:
-
-```
-# Import the csv_detective package
-from csv_detective import routine
-import os # for this example only
-
-# Replace by your file path
-file_path = os.path.join('.', 'tests', 'code_postaux_v201410.csv')
-
-# Open your file and run csv_detective
-inspection_results = routine(
-  file_path, # or file URL
-  num_rows=-1, # Value -1 will analyze all lines of your file, you can change with the number of lines you wish to analyze
-  save_results=False, # Default False. If True, it will save result output into the same directory as the analyzed file, using the same name as your file and .json extension
-  output_profile=True, # Default False. If True, returned dict will contain a property "profile" indicating profile (min, max, mean, tops...) of every column of you csv
-  output_schema=True, # Default False. If True, returned dict will contain a property "schema" containing basic [tableschema](https://specs.frictionlessdata.io/table-schema/) of your file. This can be use to validate structure of other csv which should match same structure. 
-)
-```
-
-## So What Do You Get ?
-
-### Output
-
-The program creates a `Python` dictionnary with the following information :
-
-```
-{
-    "encoding": "windows-1252", 			        # Encoding detected
-    "separator": ";",						# Detected CSV separator
-    "header_row_idx": 0					# Index of the header (aka how many lines to skip to get it)
-    "headers": ['code commune INSEE', 'nom de la commune', 'code postal', "libellé d'acheminement"], # Header row
-    "total_lines": 42,					# Number of rows (excluding header)
-    "nb_duplicates": 0,					# Number of exact duplicates in rows
-    "heading_columns": 0,					# Number of heading columns
-    "trailing_columns": 0,					# Number of trailing columns
-    "categorical": ['Code commune']         # Columns that contain less than 25 different values (arbitrary threshold)
-    "columns": { # Property that conciliate detection from labels and content of a column
-        "Code commune": {
-            "python_type": "string",
-            "format": "code_commune_insee",
-            "score": 1.0
-        },
-    },
-    "columns_labels": { # Property that return detection from header columns
-        "Code commune": {
-            "python_type": "string",
-            "format": "code_commune_insee",
-            "score": 0.5
-        },
-    },
-    "columns_fields": { # Property that return detection from content columns
-        "Code commune": {
-            "python_type": "string",
-            "format": "code_commune_insee",
-            "score": 1.25
-        },
-    },
-    "profile": {
-      "column_name" : {
-        "min": 1, # only int and float
-        "max: 12, # only int and float
-        "mean": 5, # only int and float
-        "std": 5, # only int and float
-        "tops": [  # 10 most frequent values in the column
-          "xxx",
-          "yyy",
-          "..."
-        ],
-        "nb_distinct": 67, # number of distinct values
-        "nb_missing_values": 102 # number of empty cells in the column
-      }
-    },
-    "schema": { # TableSchema of the file if `output_schema` was set to `True`
-      "$schema": "https://frictionlessdata.io/schemas/table-schema.json",
-      "name": "",
-      "title": "",
-      "description": "",
-      "countryCode": "FR",
-      "homepage": "",
-      "path": "https://github.com/datagouv/csv-detective",
-      "resources": [],
-      "sources": [
-        {"title": "Spécification Tableschema", "path": "https://specs.frictionlessdata.io/table-schema"},
-        {"title": "schema.data.gouv.fr", "path": "https://schema.data.gouv.fr"}
-      ],
-      "created": "2023-02-10",
-      "lastModified": "2023-02-10",
-      "version": "0.0.1",
-      "contributors": [
-        {"title": "Table schema bot", "email": "schema@data.gouv.fr", "organisation": "data.gouv.fr", "role": "author"}
-      ],
-      "fields": [
-        {
-          "name": "Code commune",
-          "description": "Le code INSEE de la commune",
-          "example": "23150",
-          "type": "string",
-          "formatFR": "code_commune_insee",
-          "constraints": {
-            "required": False,
-            "pattern": "^([013-9]\\d|2[AB1-9])\\d{3}$",
-          }
-        }
-      ]
-    }
-}
-```
-
-The output slightly differs depending on the file format:
-- csv files have `encoding` and `separator`
-- xls, xls, ods files have `engine` and `sheet_name`
-
-### What Formats Can Be Detected
-
-Includes :
-
-- Communes, Départements, Régions, Pays
-- Codes Communes, Codes Postaux, Codes Departement, ISO Pays
-- Codes CSP, Description CSP, SIREN
-- E-Mails, URLs, Téléphones FR
-- Years, Dates, Jours de la Semaine FR
-- UUIDs, Mongo ObjectIds
-
-### Format detection and scoring
-For each column, 3 scores are computed for each format, the higher the score, the more likely the format:
-- the field score based on the values contained in the column (0.0 to 1.0).
-- the label score based on the header of the column (0.0 to 1.0).
-- the overall score, computed as `field_score * (1 + label_score/2)` (0.0 to 1.5).
-
-The overall score computation aims to give more weight to the column contents while
-still leveraging the column header.
-
-#### `limited_output` - Select the output mode you want for json report
-
-This option allows you to select the output mode you want to pass. To do so, you have to pass a `limited_output` argument to the `routine` function. This variable has two possible values:
-
-- `limited_output` defaults to `True` which means report will contain only detected column formats based on a pre-selected threshold proportion in data. Report result is the standard output (an example can be found above in 'Output' section).
-Only the format with highest score is present in the output.
-- `limited_output=False` means report will contain a full list of all column format possibilities for each input data columns with a value associated which match to the proportion of found column type in data. With this report, user can adjust its rules of detection based on a specific threshold and has a better vision of quality detection for each columns. Results could also be easily transformed into a dataframe (columns types in column / column names in rows) for analysis and test.
-
-## Improvement suggestions
-
-- Smarter refactors
-- Improve performances
-- Test other ways to load and process data (`pandas` alternatives)
-- Add more and more detection modules...
-
-Related ideas:
-
-- store column names to make a learning model based on column names for (possible pre-screen)
-- normalising data based on column prediction
-- entity resolution (good luck...)
-
-## Why Could This Be of Any Use ?
-
-Organisations such as [data.gouv.fr](http://data.gouv.fr) aggregate huge amounts of un-normalised data. Performing cross-examination across datasets can be difficult. This tool could help enrich the datasets metadata and facilitate linking them together.
-
-[`udata-hydra`](https://github.com/etalab/udata-hydra) is a crawler that checks, analyzes (using `csv-detective`) and APIfies all tabular files from [data.gouv.fr](http://data.gouv.fr).
-
-An early version of this analysis of all resources on data.gouv.fr can be found [here](https://github.com/Leobouloc/data.gouv-exploration).
-
-## Release
-
-The release process uses `bumpx`.
-
-```shell
-pip install -r requirements-build.txt
-```
-
-### Process
-
-1. `bumpx` will handle bumping the version according to your command (patch, minor, major)
-2. It will update the CHANGELOG according to the new version being published
-3. It will push a tag with the given version to github
-4. CircleCI will pickup this tag, build the package and publish it to pypi
-5. `bumpx` will have everything ready for the next version (version, changelog...)
-
-### Dry run
-
-```shell
-bumpx -d -v
-```
-
-### Release
-
-This will release a patch version:
-
-```shell
-bumpx -v
-```

csv_detective-0.8.1.dev1674.dist-info/licenses/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 data.gouv.fr
-
-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.