https://github.com/joaopfg/picklefriend

Typescript package compatible with python's pickle loads/dumps
https://github.com/joaopfg/picklefriend

Last synced: 6 months ago
JSON representation

Typescript package compatible with python's pickle loads/dumps

• Host: GitHub
• URL: https://github.com/joaopfg/picklefriend
• Owner: joaopfg
• License: apache-2.0
• Created: 2022-06-13T10:27:43.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-29T10:05:00.000Z (about 2 years ago)
• Last Synced: 2024-12-01T04:18:04.528Z (7 months ago)
• Language: TypeScript
• Size: 11.5 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# picklefriend

[![npm version](https://img.shields.io/npm/v/picklefriend.svg?style=flat-square)](https://www.npmjs.com/package/picklefriend)

[![build](https://img.shields.io/github/actions/workflow/status/joaopfg/picklefriend/node.js.yml?branch=main&style=flat-square&label=build)](https://github.com/joaopfg/picklefriend/actions)

[![github](https://flat.badgen.net/badge/icon/github?icon=github&label)](https://github.com/joaopfg/picklefriend/)

[![sponsors](https://img.shields.io/github/sponsors/joaopfg?style=flat-square&color=1da1f2)](https://github.com/sponsors/joaopfg/)

Typescript package compatible with python's pickle loads/dumps

# Installation

```bash

npm i picklefriend

```

# Usage

```typescript

import { pickle } from 'picklefriend'

let myString = "my test string";

let myStringDumped = pickle.dumps(myString);

let myStringLoaded = pickle.loads(myStringDumped);

console.log(myStringLoaded);

```

# Development

### Fork the main branch, clone it and entry in the root folder

```bash

git clone [email protected]:joaopfg/picklefriend.git

cd picklefriend

```

### Install the dependencies

```bash

npm install

```

### Generate the dist folder

```bash

tsc

```

### Unit tests

The unit tests are located in the `test` folder. If you want to create new tests, they must go inside this folder and the test script must be updated in `package.json`.

```bash

npm test

```