Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Slightly Slim Down README #485

Merged
merged 5 commits into from
Mar 19, 2024
Merged

Slightly Slim Down README #485

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3018775
Combine np/pd parts of README
Theelx Mar 17, 2024
b12ec9d
Remove deprecated setup.py install method
Theelx Mar 17, 2024
3ae3b93
Remove jsonpickleJS information from README
Theelx Mar 17, 2024
ff66220
Fully remove jsonpickleJS from READMME
Theelx Mar 17, 2024
06f9e04
Fix README typos
Theelx Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 7 additions & 29 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
jsonpickle
==========
jsonpickle is a library for the two-way conversion of complex Python objects
and `JSON <http://json.org/>`_. jsonpickle builds upon the existing JSON
and `JSON <http://json.org/>`_. jsonpickle builds upon existing JSON
encoders, such as simplejson, json, and ujson.

.. warning::
Expand Down Expand Up @@ -78,31 +78,17 @@ Install from github for the latest changes:

pip install git+https://github.com/jsonpickle/jsonpickle.git

If you have the files checked out for development:

::

git clone https://github.com/jsonpickle/jsonpickle.git
cd jsonpickle
python setup.py develop


Numpy Support
Numpy/Pandas Support
=============
jsonpickle includes a built-in numpy extension. If would like to encode
sklearn models, numpy arrays, and other numpy-based data then you must
enable the numpy extension by registering its handlers::
jsonpickle includes built-in numpy and pandas extensions. If you would
like to encode sklearn models, numpy arrays, pandas DataFrames, and other
numpy/pandas-based data, then you must enable the numpy and/or pandas
extensions by registering their handlers::

>>> import jsonpickle.ext.numpy as jsonpickle_numpy
>>> jsonpickle_numpy.register_handlers()

Pandas Support
==============
jsonpickle includes a built-in pandas extension. If would like to encode
pandas DataFrame or Series objects then you must enable the pandas extension
by registering its handlers::

>>> import jsonpickle.ext.pandas as jsonpickle_pandas
>>> jsonpickle_numpy.register_handlers()
>>> jsonpickle_pandas.register_handlers()

Development
Expand Down Expand Up @@ -138,14 +124,6 @@ GPG Signing
===========
Unfortunately, while versions of jsonpickle before 3.0.1 should still be signed, GPG signing support was removed from PyPi (https://blog.pypi.org/posts/2023-05-23-removing-pgp/) back in May 2023.

jsonpickleJS
============
`jsonpickleJS <https://github.com/cuthbertLab/jsonpickleJS>`_
is a javascript implementation of jsonpickle by Michael Scott Cuthbert.
jsonpickleJS can be extremely useful for projects that have parallel data
structures between Python and Javascript.

License
=======
Licensed under the BSD License. See COPYING for details.
See jsonpickleJS/LICENSE for details about the jsonpickleJS license.
Loading