Ravenports generated: 14 Jan 2024 04:52
[ravenports.git] / bucket_E5 / python-jsonpickle
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-jsonpickle
4 VERSION=                3.0.2
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Serialize arbitrary object graph into JSON (3.11)
8 SDESC[v12]=             Serialize arbitrary object graph into JSON (3.12)
9 HOMEPAGE=               https://github.com/jsonpickle/jsonpickle
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/d3/25/6e0a450430b7aa194b0f515f64820fc619314faa289458b7dfca4a026114
14 DISTFILE[1]=            jsonpickle-3.0.2-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 USES=                   cpe
25
26 DISTNAME=               jsonpickle-3.0.2.dist-info
27
28 CPE_PRODUCT=            jsonpickle
29 CPE_VENDOR=             jsonpickle_project
30 GENERATED=              yes
31
32 [PY311].USES_ON=                        python:v11,wheel
33
34 [PY312].USES_ON=                        python:v12,wheel
35
36 [FILE:2797:descriptions/desc.single]
37
38
39    :alt: Github Actions
40
41    :alt: BSD
42
43 jsonpickle
44 ==========
45 jsonpickle is a library for the two-way conversion of complex Python
46 objects
47 and [JSON].  jsonpickle builds upon the existing JSON
48 encoders, such as simplejson, json, and ujson.
49
50 .. warning::
51
52    jsonpickle can execute arbitrary Python code.
53
54    Please see the Security section for more details.
55
56 For complete documentation, please visit the
57 [jsonpickle documentation].
58
59 Bug reports and merge requests are encouraged at the
60 [jsonpickle repository on github].
61
62 jsonpickle officially supports CPython 2.7 and CPython 3.6 or greater.
63 Version support below CPython 3.7 will be dropped upon release of
64 jsonpickle 3.0.
65
66 Why jsonpickle?
67 ===============
68 Data serialized with python's pickle (or cPickle or dill) is not easily
69 readable outside of python. Using the json format, jsonpickle allows simple
70 data types to be stored in a human-readable format, and more complex data
71 types such as numpy arrays and pandas dataframes, to be machine-readable on
72 any platform that supports json. E.g., unlike pickled data, jsonpickled
73 data stored in an Amazon S3 bucket is indexible by Amazon's Athena.
74
75 Security
76 ========
77
78 jsonpickle should be treated the same as the
79 [Python stdlib pickle module]
80 from a security perspective.
81
82 .. warning::
83
84    The jsonpickle module **is not secure**.  Only unpickle data you trust.
85
86    It is possible to construct malicious pickle data which will **execute
87    arbitrary code during unpickling**.  Never unpickle data that could have
88 come
89    from an untrusted source, or that could have been tampered with.
90
91    Consider signing data with an HMAC if you need to ensure that it has not
92    been tampered with.
93
94    Safer deserialization approaches, such as reading JSON directly,
95    may be more appropriate if you are processing untrusted data.
96
97 Install
98 =======
99
100 Install from pip for the latest stable release:
101
102 ::
103
104     pip install jsonpickle
105
106 Install from github for the latest changes:
107
108 ::
109
110     pip install git+https://github.com/jsonpickle/jsonpickle.git
111
112 If you have the files checked out for development:
113
114 ::
115
116     git clone https://github.com/jsonpickle/jsonpickle.git
117     cd jsonpickle
118     python setup.py develop
119
120 Numpy Support
121 =============
122 jsonpickle includes a built-in numpy extension.  If would like to encode
123 sklearn models, numpy arrays, and other numpy-based data then you must
124 enable the numpy extension by registering its handlers::
125
126     >>> import jsonpickle.ext.numpy as jsonpickle_numpy
127     >>> jsonpickle_numpy.register_handlers()
128
129 Pandas Support
130 ==============
131 jsonpickle includes a built-in pandas extension.  If would like to encode
132 pandas DataFrame or Series objects then you must enable the pandas
133 extension
134 by registering its handlers::
135
136     >>> import jsonpickle.ext.pandas as jsonpickle_pandas
137
138
139 [FILE:112:distinfo]
140 4a8442d97ca3f77978afa58068768dba7bff2dbabe79a9647bc3cdafd4ef019f        40686 jsonpickle-3.0.2-py3-none-any.whl
141