Merge pull request #209 from Roche/dev

version 1.2.0
Roche · Oct 25, 2022 · 5d87815 · 5d87815
2 parents 0a0bf50 + 2c6cf9d
commit 5d87815
Show file tree

Hide file tree

Showing 23 changed files with 2,405 additions and 2,071 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -5,7 +5,7 @@ authors:
   given-names: "Otto"
   orcid: "https://orcid.org/0000-0002-3363-9287"
 title: "Pyreadstat"
-version: 1.1.9
+version: 1.2.0
 doi: 10.5281/zenodo.6612282
 date-released: 2018-09-24
 url: "https://github.com/Roche/pyreadstat"
diff --git a/README.md b/README.md
@@ -804,7 +804,7 @@ user defined missing values in stata/sas where characters (a to z, A to Z, \_) w
 
 ## CD/CI and Wheels
 
-A CD/CI pipeline producing the wheels is available [here](https://github.com/ofajardo/pyreadstat_wheels3). Contributions
+A CD/CI pipeline producing the wheels is available [here](https://github.com/ofajardo/pyreadstat_wheels4). Contributions
 are welcome.
 
 ## Known limitations

diff --git a/change_log.md b/change_log.md
@@ -1,4 +1,8 @@
-# 1.1.8 (github, pypi and conda 2022.07.12)
+# 1.2.0 (github, pypi and conda 2022.10.XX)
+* Fixed #206, #207
+* added pyproject.toml
+
+# 1.1.9 (github, pypi and conda 2022.07.12)
 * Adapted setup.py to work with conda forge libraries on windows
 
 # 1.1.8 (github, pypi 2022.07.11)

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: fee3178dccf7c937ff6554547f500e6c
+config: d1957ba96adbb9536e51c852822e9ccb
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -24,7 +24,7 @@ object contains the following fields:
   * number_columns : an int with the number of columns
   * number_rows : an int with the number of rows. If metadataonly option was used, it may
     be None if the number of rows could not be determined. If you need the number of rows in
-    this case you need to parse the whole file.
+    this case you need to parse the whole file. This happens for xport and por files.
   * variable_value_labels : a dict with keys being variable names, and values being a dict with values as keys and labels
     as values. It may be empty if the dataset did not contain such labels. For sas7bdat files it will be empty unless
     a sas7bcat was given. It is a combination of value_labels and variable_to_label.

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.1.9',
+    VERSION: '1.2.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; pyreadstat 1.1.9 documentation</title>
+  <title>Index &mdash; pyreadstat 1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to pyreadstat’s documentation! &mdash; pyreadstat 1.1.9 documentation</title>
+  <title>Welcome to pyreadstat’s documentation! &mdash; pyreadstat 1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -86,7 +86,7 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <li><p>number_columns : an int with the number of columns</p></li>
 <li><p>number_rows : an int with the number of rows. If metadataonly option was used, it may
 be None if the number of rows could not be determined. If you need the number of rows in
-this case you need to parse the whole file.</p></li>
+this case you need to parse the whole file. This happens for xport and por files.</p></li>
 <li><p>variable_value_labels : a dict with keys being variable names, and values being a dict with values as keys and labels
 as values. It may be empty if the dataset did not contain such labels. For sas7bdat files it will be empty unless
 a sas7bcat was given. It is a combination of value_labels and variable_to_label.</p></li>
@@ -197,7 +197,9 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <dl class="py function">
 <dt class="sig sig-object py" id="pyreadstat.pyreadstat.read_file_multiprocessing">
 <span class="sig-prename descclassname"><span class="pre">pyreadstat.pyreadstat.</span></span><span class="sig-name descname"><span class="pre">read_file_multiprocessing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyreadstat.pyreadstat.read_file_multiprocessing" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads a file in parallel using multiprocessing.</p>
+<dd><p>Reads a file in parallel using multiprocessing.
+Xport and Por files are not supported as they do not have the number of rows recorded in the metadata,
+information needed for this function.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
@@ -226,7 +228,8 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>filename_path</strong> (<em>str</em><em>, </em><em>bytes</em><em> or </em><em>Path-like object</em>) – path to the file. In Python 2.7 the string is assumed to be utf-8 encoded</p></li>
 <li><p><strong>metadataonly</strong> (<em>bool</em><em>, </em><em>optional</em>) – by default False. IF true, no data will be read but only metadata, so that you can get all elements in the
-metadata object. The data frame will be set with the correct column names but no data.</p></li>
+metadata object. The data frame will be set with the correct column names but no data.
+Notice that number_rows will be None as por files do not have the number of rows recorded in the file metadata.</p></li>
 <li><p><strong>dates_as_pandas_datetime</strong> (<em>bool</em><em>, </em><em>optional</em>) – by default False. If true dates will be transformed to pandas datetime64 instead of date.</p></li>
 <li><p><strong>apply_value_formats</strong> (<em>bool</em><em>, </em><em>optional</em>) – by default False. If true it will change values in the dataframe for they value labels in the metadata,
 if any appropiate are found.</p></li>
@@ -402,7 +405,8 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>filename_path</strong> (<em>str</em><em>, </em><em>bytes</em><em> or </em><em>Path-like object</em>) – path to the file. In python 2.7 the string is assumed to be utf-8 encoded</p></li>
 <li><p><strong>metadataonly</strong> (<em>bool</em><em>, </em><em>optional</em>) – by default False. IF true, no data will be read but only metadata, so that you can get all elements in the
-metadata object. The data frame will be set with the correct column names but no data.</p></li>
+metadata object. The data frame will be set with the correct column names but no data.
+Notice that number_rows will be None as xport files do not have the number of rows recorded in the file metadata.</p></li>
 <li><p><strong>dates_as_pandas_datetime</strong> (<em>bool</em><em>, </em><em>optional</em>) – by default False. If true dates will be transformed to pandas datetime64 instead of date.</p></li>
 <li><p><strong>encoding</strong> (<em>str</em><em>, </em><em>optional</em>) – Defaults to None. If set, the system will use the defined encoding instead of guessing it. It has to be an
 iconv-compatible name</p></li>
@@ -522,7 +526,7 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>df</strong> (<em>pandas data frame</em>) – pandas data frame to write to sav or zsav</p></li>
+<li><p><strong>df</strong> (<em>pandas data frame</em>) – pandas data frame to write to por</p></li>
 <li><p><strong>dst_path</strong> (<em>str</em><em> or </em><em>pathlib.Path</em>) – full path to the result por file</p></li>
 <li><p><strong>file_label</strong> (<em>str</em><em>, </em><em>optional</em>) – a label for the file</p></li>
 <li><p><strong>column_labels</strong> (<em>list</em><em> or </em><em>dict</em><em>, </em><em>optional</em>) – labels for columns (variables), if list must be the same length as the number of columns. Variables with no
@@ -586,7 +590,7 @@ <h1>Metadata Object Description<a class="headerlink" href="#metadata-object-desc
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>df</strong> (<em>pandas data frame</em>) – pandas data frame to write to sav or zsav</p></li>
+<li><p><strong>df</strong> (<em>pandas data frame</em>) – pandas data frame to write to xport</p></li>
 <li><p><strong>dst_path</strong> (<em>str</em><em> or </em><em>pathlib.Path</em>) – full path to the result xport file</p></li>
 <li><p><strong>file_label</strong> (<em>str</em><em>, </em><em>optional</em>) – a label for the file</p></li>
 <li><p><strong>column_labels</strong> (<em>list</em><em> or </em><em>dict</em><em>, </em><em>optional</em>) – labels for columns (variables), if list must be the same length as the number of columns. Variables with no

diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; pyreadstat 1.1.9 documentation</title>
+  <title>Python Module Index &mdash; pyreadstat 1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; pyreadstat 1.1.9 documentation</title>
+  <title>Search &mdash; pyreadstat 1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '1.1.9'
+release = '1.2.0'
 
 
 # -- General configuration ---------------------------------------------------