[ENH] Implement sort_naturally (pyjanitor-devs#628)

* Implemented first version of sort_naturally * Added test for sort_naturally * Added example for sort_naturally * Updated changelog * Add natsort to environment spec file * Line length fix * code formatting * Changed implementation of natsort. - Suggested by @zbarry. * code formatting fixes * test that the data are uncorrupted * add explanation of natural sorting to docstring * removed unnecessary source files * Added sort_naturally to list of functions in docs * Added extra test suggested by @zbarry * Added docs for sort_naturally * backticks on natsort for formatting
szuckerman · Feb 2, 2020 · d23e401 · d23e401
1 parent e6446ef
commit d23e401
Show file tree

Hide file tree

Showing 56 changed files with 519 additions and 329 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,7 @@
 new version (on deck)
 =====================
--[DOC]: Added an example for groupby_agg in general functions @samukweku
+- [DOC]: Added an example for groupby_agg in general functions @samukweku
+- [ENH]: Contributed ``sort_naturally()`` function. @ericmjl
 
 v0.20.0
 =======

diff --git a/docs/janitor.functions/janitor.add_column.md b/docs/janitor.functions/janitor.add_column.md
diff --git a/docs/janitor.functions/janitor.add_columns.md b/docs/janitor.functions/janitor.add_columns.md
diff --git a/docs/janitor.functions/janitor.bin_numeric.md b/docs/janitor.functions/janitor.bin_numeric.md
diff --git a/docs/janitor.functions/janitor.change_type.md b/docs/janitor.functions/janitor.change_type.md
diff --git a/docs/janitor.functions/janitor.clean_names.md b/docs/janitor.functions/janitor.clean_names.md
diff --git a/docs/janitor.functions/janitor.coalesce.md b/docs/janitor.functions/janitor.coalesce.md
diff --git a/docs/janitor.functions/janitor.collapse_levels.md b/docs/janitor.functions/janitor.collapse_levels.md
diff --git a/docs/janitor.functions/janitor.concatenate_columns.md b/docs/janitor.functions/janitor.concatenate_columns.md
diff --git a/docs/janitor.functions/janitor.convert_excel_date.md b/docs/janitor.functions/janitor.convert_excel_date.md
diff --git a/docs/janitor.functions/janitor.convert_matlab_date.md b/docs/janitor.functions/janitor.convert_matlab_date.md
diff --git a/docs/janitor.functions/janitor.convert_unix_date.md b/docs/janitor.functions/janitor.convert_unix_date.md
diff --git a/docs/janitor.functions/janitor.currency_column_to_numeric.md b/docs/janitor.functions/janitor.currency_column_to_numeric.md
diff --git a/docs/janitor.functions/janitor.deconcatenate_column.md b/docs/janitor.functions/janitor.deconcatenate_column.md
diff --git a/docs/janitor.functions/janitor.drop_duplicate_columns.md b/docs/janitor.functions/janitor.drop_duplicate_columns.md
diff --git a/docs/janitor.functions/janitor.dropnotnull.md b/docs/janitor.functions/janitor.dropnotnull.md
diff --git a/docs/janitor.functions/janitor.encode_categorical.md b/docs/janitor.functions/janitor.encode_categorical.md
diff --git a/docs/janitor.functions/janitor.expand_column.md b/docs/janitor.functions/janitor.expand_column.md
diff --git a/docs/janitor.functions/janitor.fill_empty.md b/docs/janitor.functions/janitor.fill_empty.md
diff --git a/docs/janitor.functions/janitor.filter_column_isin.md b/docs/janitor.functions/janitor.filter_column_isin.md
diff --git a/docs/janitor.functions/janitor.filter_date.md b/docs/janitor.functions/janitor.filter_date.md
diff --git a/docs/janitor.functions/janitor.filter_on.md b/docs/janitor.functions/janitor.filter_on.md
diff --git a/docs/janitor.functions/janitor.filter_string.md b/docs/janitor.functions/janitor.filter_string.md
diff --git a/docs/janitor.functions/janitor.find_replace.md b/docs/janitor.functions/janitor.find_replace.md
diff --git a/docs/janitor.functions/janitor.get_dupes.md b/docs/janitor.functions/janitor.get_dupes.md
diff --git a/docs/janitor.functions/janitor.get_features_targets.md b/docs/janitor.functions/janitor.get_features_targets.md
diff --git a/docs/janitor.functions/janitor.groupby_agg.md b/docs/janitor.functions/janitor.groupby_agg.md
diff --git a/docs/janitor.functions/janitor.impute.md b/docs/janitor.functions/janitor.impute.md
diff --git a/docs/janitor.functions/janitor.label_encode.md b/docs/janitor.functions/janitor.label_encode.md
diff --git a/docs/janitor.functions/janitor.limit_column_characters.md b/docs/janitor.functions/janitor.limit_column_characters.md
diff --git a/docs/janitor.functions/janitor.min_max_scale.md b/docs/janitor.functions/janitor.min_max_scale.md
diff --git a/docs/janitor.functions/janitor.remove_columns.md b/docs/janitor.functions/janitor.remove_columns.md
diff --git a/docs/janitor.functions/janitor.remove_empty.md b/docs/janitor.functions/janitor.remove_empty.md
diff --git a/docs/janitor.functions/janitor.rename_column.md b/docs/janitor.functions/janitor.rename_column.md
diff --git a/docs/janitor.functions/janitor.reorder_columns.md b/docs/janitor.functions/janitor.reorder_columns.md
diff --git a/docs/janitor.functions/janitor.round_to_fraction.md b/docs/janitor.functions/janitor.round_to_fraction.md
diff --git a/docs/janitor.functions/janitor.row_to_names.md b/docs/janitor.functions/janitor.row_to_names.md
diff --git a/docs/janitor.functions/janitor.select_columns.md b/docs/janitor.functions/janitor.select_columns.md
diff --git a/docs/janitor.functions/janitor.shuffle.md b/docs/janitor.functions/janitor.shuffle.md
diff --git a/docs/janitor.functions/janitor.take_first.md b/docs/janitor.functions/janitor.take_first.md
diff --git a/docs/janitor.functions/janitor.then.md b/docs/janitor.functions/janitor.then.md
diff --git a/docs/janitor.functions/janitor.to_datetime.md b/docs/janitor.functions/janitor.to_datetime.md
diff --git a/docs/janitor.functions/janitor.transform_column.md b/docs/janitor.functions/janitor.transform_column.md
diff --git a/docs/janitor.functions/janitor.transform_columns.md b/docs/janitor.functions/janitor.transform_columns.md
diff --git a/docs/janitor.functions/janitor.unionize_dataframe_categories.md b/docs/janitor.functions/janitor.unionize_dataframe_categories.md
diff --git a/docs/janitor.functions/janitor.update_where.md b/docs/janitor.functions/janitor.update_where.md
diff --git a/docs/reference/general_functions.rst b/docs/reference/general_functions.rst
@@ -79,4 +79,6 @@ Other
 
     then
     shuffle
+    reset_index_inplace
     count_cumulative_unique
+    sort_naturally
diff --git a/docs/reference/janitor.functions/janitor.sort_naturally.md b/docs/reference/janitor.functions/janitor.sort_naturally.md
@@ -0,0 +1,6 @@
+janitor.sort\_naturally
+=====================
+
+.. currentmodule:: janitor
+
+.. autofunction:: sort_naturally
diff --git a/environment-dev.yml b/environment-dev.yml
@@ -20,6 +20,7 @@ dependencies:
 - make
 - missingno
 - mypy
+- natsort
 - nbsphinx
 - nox
 - numpy>=1.16