Skip to content

Commit

Permalink
Merge pull request #348 from sciris/rc2.0.0c
Browse files Browse the repository at this point in the history
Rc2.0.0c
  • Loading branch information
cliffckerr committed Aug 17, 2022
2 parents 66ad5bd + 5b27695 commit 6dde4ed
Show file tree
Hide file tree
Showing 20 changed files with 1,318 additions and 333 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ New functions and methods
#. ``sc.randsleep()`` sleeps for a nondeterministic period of time
#. ``sc.loadzip()`` extracts (or reads data from) zip files
#. ``sc.loadyaml()`` and ``sc.saveyaml()`` load and save YAML files, respectively.
#. ``sc.download()`` downloads multiple files in parallel.
#. ``sc.LazyModule()`` handles lazily loaded modules (see ``sc.importbyname()`` for usage).

Bugfixes
~~~~~~~~
Expand Down Expand Up @@ -49,6 +51,11 @@ Improvements
#. ``sc.checktype()`` now includes boolean arrays as being ``arraylike``, and has a new ``'bool'`` option.
#. Added ``dict_keys()``, ``dict_values()``, and ``dict_items()`` methods for ``sc.odict()``.
#. File-saving functions now have a ``sanitizepath`` argument (previously, some used file path sanitization and others didn't). They also now return the full path of the saved file.
#. ``sc.Spreadsheet()`` now has a ``new()`` method that creates a blank workbook.
#. ``sc.animation()`` now defaults to ``ffmpeg`` for saving.
#. ``sc.date()`` can now read ``np.datetime64`` objects.
#. ``sc.wget()`` can now save to files.
#. ``sc.importbyname()`` can now load multiple modules, and load them lazily.

Housekeeping
~~~~~~~~~~~~
Expand All @@ -57,6 +64,8 @@ Housekeeping
#. Most instances of ``DeprecationWarning`` have been changed to ``FutureWarning``.
#. Python 2 compatibility functions (e.g. ``sc.loadobj2or3()``) have been moved to a separate module, ``sc.sc_legacy``, which is no longer imported by default.
#. Added style and contributing guides.
#. Added official support for Python 3.7-3.10.
#. ``sc.wget()`` was renamed ``sc.urlopen()``.

Regression information
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
16 changes: 16 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
======================
Contributing to Sciris
======================

Welcome! We are thrilled you are interested in contributing to Sciris. This document will help you get started.

- The Sciris community follows a `code of conduct`_. By participating in this project, you agree to abide by its terms.
- Take a look at our house `style guide`_. Sciris more or less follows Google's Python style guide, but with some exceptions.
- Feel free to `open an issue`_ on more or less anything! This project is small enough that we don't need a formal triage system.
- Pull requests should be made against ``develop``. In addition to following the `style guide`_, please make sure the tests pass (``run_tests`` in the ``tests`` folder; they also run via GitHub actions).

If you have any other questions, please reach out to us: info@sciris.org. Thank you!

.. _code of conduct: https://github.com/sciris/sciris/blob/develop/CODE_OF_CONDUCT.rst
.. _style guide: https://github.com/sciris/sciris/blob/develop/STYLE_GUIDE.rst
.. _open an issue: https://github.com/sciris/sciris/issues/new/choose
1 change: 1 addition & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../CONTRIBUTING.rst
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Contents

overview
whatsnew
style_guide
contributing
code_of_conduct
style_guide

.. autosummary::
:toctree: _autosummary
Expand Down
6 changes: 3 additions & 3 deletions sciris/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

# Import everything
from .sc_version import *
from .sc_settings import *
from .sc_utils import *
from .sc_printing import *
from .sc_datetime import *
from .sc_nested import *
from .sc_math import *
from .sc_odict import *
from .sc_settings import *
from .sc_datetime import *
from .sc_math import *
from .sc_dataframe import *
from .sc_fileio import *
from .sc_profiling import *
Expand Down

0 comments on commit 6dde4ed

Please sign in to comment.