Skip to content

Commit

Permalink
Merge branch 'release/0.9.1'
Browse files Browse the repository at this point in the history
Version 0.9.1
  • Loading branch information
vnmabus committed Oct 19, 2023
2 parents f942b18 + 89bea8a commit 4634ed2
Show file tree
Hide file tree
Showing 23 changed files with 355 additions and 321 deletions.
15 changes: 6 additions & 9 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ['3.7', '3.8', '3.9']
python-version: ['3.9', '3.10', '3.11']

steps:
- uses: actions/checkout@v2
Expand All @@ -23,16 +23,13 @@ jobs:

- name: Install dependencies
run: |
pip3 install codecov pytest-cov || pip3 install --user codecov pytest-cov;
pip3 install pytest-cov || pip3 install --user pytest-cov;
- name: Run tests
run: |
pip3 install .
coverage run --source=rdata/ --omit=rdata/tests/ setup.py test;
- name: Generate coverage XML
run: |
coverage xml
pip3 debug --verbose .
pip3 install ".[test]"
pytest --cov=rdata/ --cov-report=xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v2
uses: codecov/codecov-action@v3
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
include MANIFEST.in
include rdata/VERSION
include LICENSE
include rdata/py.typed
include *.txt
27 changes: 22 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
rdata
=====

|build-status| |docs| |coverage| |landscape| |pypi| |zenodo|
|build-status| |docs| |coverage| |pypi| |zenodo|

Read R datasets from Python.

..
Github does not support include in README for dubious security reasons, so
we copy-paste instead. Also Github does not understand Sphinx directives.
.. include:: docs/index.rst
.. include:: docs/simpleusage.rst
The package rdata offers a lightweight way to import R datasets/objects stored
in the ".rda" and ".rds" formats into Python.
Its main advantages are:

- It is a pure Python implementation, with no dependencies on the R language or
related libraries.
Thus, it can be used anywhere where Python is supported, including the web
using `Pyodide <https://pyodide.org/>`_.
- It attempt to support all R objects that can be meaningfully translated.
As opposed to other solutions, you are no limited to import dataframes or
data with a particular structure.
- It allows users to easily customize the conversion of R classes to Python
ones.
Does your data use custom R classes?
Worry no longer, as it is possible to define custom conversions to the Python
classes of your choosing.
- It has a permissive license (MIT). As opposed to other packages that depend
on R libraries and thus need to adhere to the GPL license, you can use rdata
as a dependency on MIT, BSD or even closed source projects.

Installation
============
Expand Down Expand Up @@ -123,10 +144,6 @@ Pandas `Categorical` objects:
:scale: 100%
:target: https://codecov.io/gh/vnmabus/rdata/branch/develop

.. |landscape| image:: https://landscape.io/github/vnmabus/rdata/develop/landscape.svg?style=flat
:target: https://landscape.io/github/vnmabus/rdata/develop
:alt: Code Health

.. |pypi| image:: https://badge.fury.io/py/rdata.svg
:alt: Pypi version
:scale: 100%
Expand Down
1 change: 0 additions & 1 deletion conftest.py
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
collect_ignore = ['setup.py']
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
/functions/
/modules/
/auto_examples/
/jupyterlite_contents/
Empty file added docs/__init__.py
Empty file.
13 changes: 13 additions & 0 deletions docs/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[
{
"name": "dev",
"version": "dev",
"url": "https://rdata.readthedocs.io/en/latest/"
},
{
"name": "0.9 (stable)",
"version": "stable",
"url": "https://rdata.readthedocs.io/en/stable/",
"preferred": true
}
]
22 changes: 9 additions & 13 deletions docs/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
{{ objname | escape | underline}}


.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}

{% block methods %}
{% if methods %}
.. rubric:: Methods
.. rubric:: {{ _('Methods') }}

.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{% if item != "__init__" %}
~{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}

.. automethod:: __init__
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: Attributes

.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{% for item in methods %}
{% if item != "__init__" %}
.. automethod:: {{ item }}
{% endif %}
{%- endfor %}
{% endif %}
{% endblock %}
64 changes: 0 additions & 64 deletions docs/_templates/autosummary/module.rst

This file was deleted.

Loading

0 comments on commit 4634ed2

Please sign in to comment.